tvalentyn commented on a change in pull request #12097: URL: https://github.com/apache/beam/pull/12097#discussion_r446327362
########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. Review comment: How about "The samples on this page describe common patterns using Schemas." ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. +A Schema is a way to represent records with a fixed structure, they are useful as common beam sources produce JSON, Avro or database row objects all of which have a well defined structure. Review comment: A Schema is a way to represent records with a fixed structure. Schemas are useful because Beam sources commonly produce JSON, Avro or database row objects all of which have a well-defined structure. ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. +A Schema is a way to represent records with a fixed structure, they are useful as common beam sources produce JSON, Avro or database row objects all of which have a well defined structure. +For more information, see the [programming guide section on Schemas](/documentation/programming-guide/#what-is-a-schema). + +{{< language-switcher java >}} + +## Using Joins + +Beam supports equijoins on schema `PCollections` of Schemas where the join condition depends on the equality of a subset of fields. + +Consider using Join if you have multiple data sets that provide information about related things and their structure is known. + +For example let's say we have two different files with user data: one file has names and email addresses; the other file has names and phone numbers. Review comment: Should we use consistent terminology here: 'collection' or 'dataset' instead of several terms: file, collection, dataset, data set? ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. Review comment: actually, let me add @rosetn @davidwrede who can guide better on the style of Website narrative. ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. +A Schema is a way to represent records with a fixed structure, they are useful as common beam sources produce JSON, Avro or database row objects all of which have a well defined structure. Review comment: Might be easier to read if we break up this sentence. ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. +A Schema is a way to represent records with a fixed structure, they are useful as common beam sources produce JSON, Avro or database row objects all of which have a well defined structure. +For more information, see the [programming guide section on Schemas](/documentation/programming-guide/#what-is-a-schema). + +{{< language-switcher java >}} + +## Using Joins + +Beam supports equijoins on schema `PCollections` of Schemas where the join condition depends on the equality of a subset of fields. + +Consider using Join if you have multiple data sets that provide information about related things and their structure is known. Review comment: s/Join/[`Join`](https://beam.apache.org/releases/javadoc/2.21.0/org/apache/beam/sdk/schemas/transforms/Join.html) (Adding link + ticks) ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. +A Schema is a way to represent records with a fixed structure, they are useful as common beam sources produce JSON, Avro or database row objects all of which have a well defined structure. +For more information, see the [programming guide section on Schemas](/documentation/programming-guide/#what-is-a-schema). + +{{< language-switcher java >}} + +## Using Joins + +Beam supports equijoins on schema `PCollections` of Schemas where the join condition depends on the equality of a subset of fields. + +Consider using Join if you have multiple data sets that provide information about related things and their structure is known. + +For example let's say we have two different files with user data: one file has names and email addresses; the other file has names and phone numbers. +You can join the two data sets using the name as a common key and the other data as the associated values. +After the join, you have one dataset that contains all the information (email address and phone numbers) associated with each name. + +The following conceptual examples uses two input collections to show the mechanism of Join. Review comment: s/examples/example ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. +A Schema is a way to represent records with a fixed structure, they are useful as common beam sources produce JSON, Avro or database row objects all of which have a well defined structure. +For more information, see the [programming guide section on Schemas](/documentation/programming-guide/#what-is-a-schema). + +{{< language-switcher java >}} + +## Using Joins + +Beam supports equijoins on schema `PCollections` of Schemas where the join condition depends on the equality of a subset of fields. + +Consider using Join if you have multiple data sets that provide information about related things and their structure is known. + +For example let's say we have two different files with user data: one file has names and email addresses; the other file has names and phone numbers. +You can join the two data sets using the name as a common key and the other data as the associated values. +After the join, you have one dataset that contains all the information (email address and phone numbers) associated with each name. + +The following conceptual examples uses two input collections to show the mechanism of Join. + +You can define the Schema and the schema `PCollection` and then perform join on the two `PCollections` using a [Join](https://beam.apache.org/releases/javadoc/2.21.0/org/apache/beam/sdk/schemas/transforms/Join.html). Review comment: How about: 'We define PCollections, their schemas and then perform..." ########## File path: website/www/site/content/en/documentation/patterns/schema.md ########## @@ -0,0 +1,49 @@ +--- +title: "Schema Patterns" +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Schema Patterns + +The samples on this page show you common patterns using Schemas. +A Schema is a way to represent records with a fixed structure, they are useful as common beam sources produce JSON, Avro or database row objects all of which have a well defined structure. +For more information, see the [programming guide section on Schemas](/documentation/programming-guide/#what-is-a-schema). + +{{< language-switcher java >}} + +## Using Joins + +Beam supports equijoins on schema `PCollections` of Schemas where the join condition depends on the equality of a subset of fields. + +Consider using Join if you have multiple data sets that provide information about related things and their structure is known. + +For example let's say we have two different files with user data: one file has names and email addresses; the other file has names and phone numbers. +You can join the two data sets using the name as a common key and the other data as the associated values. +After the join, you have one dataset that contains all the information (email address and phone numbers) associated with each name. + +The following conceptual examples uses two input collections to show the mechanism of Join. + +You can define the Schema and the schema `PCollection` and then perform join on the two `PCollections` using a [Join](https://beam.apache.org/releases/javadoc/2.21.0/org/apache/beam/sdk/schemas/transforms/Join.html). Review comment: Nit: let's add ticks around Join since it refers to a code statement `Join`. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
