apache / apache/beam

Update Beam documentation to include Schema type mapping between various SDK languages

Open
#21,160 0 comments 0 reactions 0 assignees View on GitHub
cross-language improvement P3 website
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

Currently documentation regarding how language specific types map to Beam schema types and vice versa are scattered in different locations.

For example,
* Following describes how Python types map to Beam schema types.

[https://beam.apache.org/releases/pydoc/2.32.0/apache_beam.typehints.schemas.html](https://beam.apache.org/releases/pydoc/2.32.0/apache_beam.typehints.schemas.html)
*  Beam Programming Guides gives some details regarding types and few examples but this seems to be incomplete.

[https://beam.apache.org/documentation/programming-guide/#schemas](https://beam.apache.org/documentation/programming-guide/#schemas)
*  Following has a table that describes how types from various languages relate to each other.

[https://docs.google.com/document/d/1uu9pJktzT_O3DxGd1-Q2op4nRk4HekIZbzi-0oTAips/edit#bookmark=id.tlciv62z2d9u](https://docs.google.com/document/d/1uu9pJktzT_O3DxGd1-Q2op4nRk4HekIZbzi-0oTAips/edit#bookmark=id.tlciv62z2d9u)
* There's limited documentation on using Python NamedTupes to properly create Beam Rows.

 

Ideally, we should extend the Beam Programming Guide (or create a new guide) to describe currently supported Schema types and how types from various SDK languages map to such types. We should also have enough examples to illustrate the usage.

 

Imported from Jira [BEAM-13170](https://issues.apache.org/jira/browse/BEAM-13170). Original Jira may contain additional context.
Reported by: chamikara.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.