Uploaded image for project: 'Beam'
  1. Beam
  2. BEAM-9275 BIP-1: Beam Schema Options
  3. BEAM-9035

BIP-1: Typed options for Row Schema and Fields



    • Type: Sub-task
    • Status: Resolved
    • Priority: P2
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.21.0
    • Component/s: sdk-java-core
    • Labels:


      This is the first issue of a multipart commit: this ticket implements the basic infrastructure of options on row and field.

      Full explanation:

      Introduce the concept of Options in Beam Schema’s to add extra context to fields and schema. In contracts to metadata, options would be added to fields, logical types and rows. In the options schema convertors can add options/annotations/decorators that were in the original schema, this context can be used in the rest of the pipeline for specific transformations or augment the end schema in the target output.

      Examples of options are:

      • informational: like the source of the data, ...
      • drive decisions further in the pipeline: flatten a row into another, rename a field, ...
      • influence something in the output: like cluster index, primary key, ...
      • logical type information

      And option is a key/typed value combination. The advantages of having the value types is: 

      • Having strongly typed options would give a portable way of Logical Types to have structured information that could be shared over different languages.
      • This could keep the type intact when mapping from a formats that have strongly typed options (example: Protobuf).

      This is part of a multi ticket implementation. The following tickets are related:

      1. Typed options for Row Schema and Fields
      2. Convert Proto Options to Beam Schema options
      3. Convert Avro extra information for Beam string options
      4. Replace meta data with Logical Type options
      5. Extract meta data in Calcite SQL to Beam options
      6. Extract meta data in Zeta SQL to Beam options
      7. Add java example of using option in a transform 

      This feature is discussed with Reuven Lax, Brian Hulette


          Issue Links



              • Assignee:
                alexvanboxel Alex Van Boxel
                alexvanboxel Alex Van Boxel
              • Votes:
                0 Vote for this issue
                1 Start watching this issue


                • Created:

                  Time Tracking

                  Original Estimate - Not Specified
                  Not Specified
                  Remaining Estimate - 0h
                  Time Spent - 8h 50m
                  8h 50m