[
https://issues.apache.org/jira/browse/BEAM-13170?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Chamikara Madhusanka Jayalath updated BEAM-13170:
-------------------------------------------------
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]
* 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]
* 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]
* 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.
was:
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]
* 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]
* 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]
* 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.
> Update Beam documentation to include Schema type mapping between various SDK
> languages
> --------------------------------------------------------------------------------------
>
> Key: BEAM-13170
> URL: https://issues.apache.org/jira/browse/BEAM-13170
> Project: Beam
> Issue Type: Improvement
> Components: cross-language
> Reporter: Chamikara Madhusanka Jayalath
> Priority: P1
>
> 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]
> * 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]
> * 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]
> * 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.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
