You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "acrites (via GitHub)" <gi...@apache.org> on 2026/01/21 20:40:17 UTC

[PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

acrites opened a new pull request, #37376:
URL: https://github.com/apache/beam/pull/37376

   Adds a new SchemaCoderPayload proto to use for portable SchemaCoders.
   
   This new payload is currently not used. In the future, each SDK can use this proto instead of a custom coder blob to represent SchemaCoder objects. This will allow the runners to interpret the underlying Schema to do things like compatibility checks and encoding position reorderings.
   
   Addresses #31686 and many others.
   ------------------------
   
   Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
   
    - [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
    - [ ] Update `CHANGES.md` with noteworthy changes.
    - [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
   
   To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
   
   GitHub Actions Tests Status (on master branch)
   ------------------------------------------------------------------------------------------------
   [![Build python source distribution and wheels](https://github.com/apache/beam/actions/workflows/build_wheels.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
   [![Python tests](https://github.com/apache/beam/actions/workflows/python_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Java tests](https://github.com/apache/beam/actions/workflows/java_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Go tests](https://github.com/apache/beam/actions/workflows/go_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
   
   See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

Posted by "chamikaramj (via GitHub)" <gi...@apache.org>.
chamikaramj commented on code in PR #37376:
URL: https://github.com/apache/beam/pull/37376#discussion_r2729459282


##########
model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/schema.proto:
##########
@@ -237,3 +237,23 @@ message MapTypeEntry {
 message LogicalTypeValue {
   FieldValue value = 1;
 }
+
+// Information needed to represent a Coder of type SCHEMA.
+message SchemaCoderPayload {
+  // The schema to use for encoding corresponding Row types.
+  Schema schema = 1;
+
+  // Function mapping from underlying object to Row type.
+  FunctionSpec to_row_fn = 2;
+
+  // Function mapping from Row type to underlying object.
+  FunctionSpec from_row_fn = 3;

Review Comment:
   Is the expectation that this function spec is only understandable by a given SDK. If so I have a couple of questions.
   
   (1) How can one (a runner for example) identify the correct SDK given the coder ? Should we also attach the environment ID to the coder ? (I don't think just URL in the function spec is adequate).
   
   (2) Does this mean that this coder is not truly portable ? For example, cannot be used in a cross-language boundary ? To make it truly portable, we might need a list of FunctionSpecs with entries for multiple environments.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

Posted by "kennknowles (via GitHub)" <gi...@apache.org>.
kennknowles commented on code in PR #37376:
URL: https://github.com/apache/beam/pull/37376#discussion_r2737282821


##########
model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/schema.proto:
##########
@@ -237,3 +237,23 @@ message MapTypeEntry {
 message LogicalTypeValue {
   FieldValue value = 1;
 }
+
+// Information needed to represent a Coder of type SCHEMA.
+message SchemaCoderPayload {
+  // The schema to use for encoding corresponding Row types.
+  Schema schema = 1;
+
+  // Function mapping from underlying object to Row type.
+  FunctionSpec to_row_fn = 2;
+
+  // Function mapping from Row type to underlying object.
+  FunctionSpec from_row_fn = 3;

Review Comment:
   (but mostly, yes, SchemaCoder is not portable, except that SDKs can ignore the to/from function and operate on the underlying Row directly... but at great risk of data corruption)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

Posted by "kennknowles (via GitHub)" <gi...@apache.org>.
kennknowles commented on code in PR #37376:
URL: https://github.com/apache/beam/pull/37376#discussion_r2737279505


##########
model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/schema.proto:
##########
@@ -237,3 +237,23 @@ message MapTypeEntry {
 message LogicalTypeValue {
   FieldValue value = 1;
 }
+
+// Information needed to represent a Coder of type SCHEMA.
+message SchemaCoderPayload {
+  // The schema to use for encoding corresponding Row types.
+  Schema schema = 1;
+
+  // Function mapping from underlying object to Row type.
+  FunctionSpec to_row_fn = 2;
+
+  // Function mapping from Row type to underlying object.
+  FunctionSpec from_row_fn = 3;

Review Comment:
   I had the same comment in discussion about this. The URN of it will be something like `beam:dofn:javasdk` so the URN of the FunctionSpec indicates the SDK. Or anyhow that is my recollection of why I decided it was redundant to have an environment. It is the nature of coders to be the boundary between environments, so each environment can interpret the FunctionSpec. (like maybe in some weird world the java sdk environment actually finds a way to use `beam:dofn:pythonsdk`?).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #37376:
URL: https://github.com/apache/beam/pull/37376#issuecomment-3781068801

   ## Summary of Changes
   
   Hello @acrites, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
   
   This pull request introduces a new `SchemaCoderPayload` Protocol Buffer message and registers a corresponding `SCHEMA` coder type in the Beam Runner API. The primary goal is to establish a standardized, portable representation for `SchemaCoder` objects across different SDKs. While not immediately utilized, this infrastructure will enable Beam runners to interpret underlying schemas, facilitating future enhancements such as compatibility validation and optimized encoding strategies for data processing.
   
   ### Highlights
   
   * **New Schema Coder Type**: Introduced a new `SCHEMA` coder type (value 18) within the `StandardCoders` enum in `beam_runner_api.proto`, specifically for arbitrary types convertible to and from row objects.
   * **SchemaCoderPayload Definition**: Defined a new `SchemaCoderPayload` message in `schema.proto` to encapsulate information required for `SCHEMA` type coders. This payload includes the `schema` itself, functions to convert `to_row_fn` and `from_row_fn`, and `additional_coder_infos`.
   * **Future-proofing Schema Coders**: This change is a foundational step, not yet actively used, to allow SDKs to represent `SchemaCoder` objects using a standardized proto, enabling advanced runner capabilities like compatibility checks and encoding reorderings.
   
   🧠 **New Feature in Public Preview:** You can now enable **Memory** to help **Gemini Code Assist** learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. **Click [here](https://codeassist.google/code-review/login) to enable Memory in your admin console.**
   
   
   
   
   
   
   
   <details>
   <summary><b>Using Gemini Code Assist</b></summary>
   <br>
   
   The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
   
   <b>Invoking Gemini</b>
   
   You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page.
   
   Feature | Command | Description
   --- | --- | ---
   Code Review | `/gemini review` | Performs a code review for the current pull request in its current state.
   Pull Request Summary | `/gemini summary` | Provides a summary of the current pull request in its current state.
   Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments.
   Help | `/gemini help` | Displays a list of available commands.
   
   <b>Customization</b>
   
   To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a `.gemini/` folder in the base of the repository. Detailed instructions can be found [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
   
   <b>Limitations & Feedback</b>
   
   Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
   
   <b>You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the [Gemini Code Assist IDE Extension](https://cloud.google.com/products/gemini/code-assist).</b>
   </details>
   
   
   
   
   [^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

Posted by "kennknowles (via GitHub)" <gi...@apache.org>.
kennknowles merged PR #37376:
URL: https://github.com/apache/beam/pull/37376


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

Posted by "acrites (via GitHub)" <gi...@apache.org>.
acrites commented on PR #37376:
URL: https://github.com/apache/beam/pull/37376#issuecomment-3785291400

   @kennknowles since this is the proto we were talking about.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adds a new SchemaCoderPayload proto to use for portable SchemaCoders. [beam]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37376:
URL: https://github.com/apache/beam/pull/37376#issuecomment-3781382954

   Assigning reviewers:
   
   R: @Abacn added as fallback since no labels match configuration
   
   
   Note: If you would like to opt out of this review, comment `assign to next reviewer`.
   
   Available commands:
   - `stop reviewer notifications` - opt out of the automated review tooling
   - `remind me after tests pass` - tag the comment author after tests pass
   - `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
   
   The PR bot will only process comments in the main thread (not review comments).


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org