Skip to content

Add section to README describing PCollections#35012

Closed
stiv1qaz1 wants to merge 3 commits intoapache:masterfrom
stiv1qaz1:add-pcollection-readme-section
Closed

Add section to README describing PCollections#35012
stiv1qaz1 wants to merge 3 commits intoapache:masterfrom
stiv1qaz1:add-pcollection-readme-section

Conversation

@stiv1qaz1
Copy link

This commit adds a new section titled 'Working with PCollections' to the main README.md file.

The section explains:

  • What a PCollection is.
  • How PCollections are created (from in-memory data and external sources).
  • Key characteristics of PCollections (immutability, element type, bounded vs. unbounded).
  • A brief overview of common operations performed on PCollections, leading into PTransforms.

Please add a meaningful description for your change here


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.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit 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
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

This commit adds a new section titled 'Working with PCollections' to the main README.md file.

The section explains:
- What a PCollection is.
- How PCollections are created (from in-memory data and external sources).
- Key characteristics of PCollections (immutability, element type, bounded vs. unbounded).
- A brief overview of common operations performed on PCollections, leading into PTransforms.
Previously, BigQueryAvroUtils.toGenericAvroSchema used a static namespace
('org.apache.beam.sdk.io.gcp.bigquery') for all generated Avro record schemas,
including those for nested structures. This caused an org.apache.avro.SchemaParseException
if two record fields with the same simple name (e.g., 'identifier') appeared at
different levels of nesting within a BigQuery schema, as they would both attempt
to define an Avro record type with the same full name (e.g.,
'org.apache.beam.sdk.io.gcp.bigquery.identifier').

This commit refactors the Avro schema generation logic:
1. It introduces a recursive helper method, toGenericAvroSchemaRecursive,
   that takes the current namespace and a Schema.Names context as parameters.
2. When a nested record is encountered, the namespace for its Avro record type
   is now derived from the full name of its parent Avro record type.
   For example, a field 'nestedRec' inside an Avro record 'my.parentRec'
   will result in an Avro record type named 'nestedRec' within the
   namespace 'my.parentRec'. Its full Avro name becomes 'my.parentRec.nestedRec'.
3. A utility method sanitizeNameForAvro is added to ensure that names derived
   from BigQuery fields are valid for use in Avro record and field names.

This change ensures that even if multiple BigQuery fields share the same simple
name, their corresponding Avro record types will have unique full names if
their parent structures are different, thus resolving the SchemaParseException.

Addresses issues similar to the one described where nested fields named 'identifier'
caused a type redefinition error when converting to Avro schema.
Previously, BigQueryAvroUtils.toGenericAvroSchema used a static namespace
('org.apache.beam.sdk.io.gcp.bigquery') for all generated Avro record schemas,
including those for nested structures. This caused an org.apache.avro.SchemaParseException
if two record fields with the same simple name (e.g., 'identifier') appeared at
different levels of nesting within a BigQuery schema, as they would both attempt
to define an Avro record type with the same full name (e.g.,
'org.apache.beam.sdk.io.gcp.bigquery.identifier').

This commit refactors the Avro schema generation logic:
1. It introduces a recursive helper method, toGenericAvroSchemaRecursive,
   that takes the current namespace and a Schema.Names context as parameters.
2. When a nested record is encountered, the namespace for its Avro record type
   is now derived from the full name of its parent Avro record type.
   For example, a field 'nestedRec' inside an Avro record 'my.parentRec'
   will result in an Avro record type named 'nestedRec' within the
   namespace 'my.parentRec'. Its full Avro name becomes 'my.parentRec.nestedRec'.
3. A utility method sanitizeNameForAvro is added to ensure that names derived
   from BigQuery fields are valid for use in Avro record and field names.

This change ensures that even if multiple BigQuery fields share the same simple
name, their corresponding Avro record types will have unique full names if
their parent structures are different, thus resolving the SchemaParseException.

Addresses issues similar to the one described where nested fields named 'identifier'
caused a type redefinition error when converting to Avro schema.
@github-actions
Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@chamikaramj
Copy link
Contributor

Could you justify the code changes here in a Github issue or in an email thread in the dev list ?

@github-actions
Copy link
Contributor

This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 1 week if no further activity occurs. If you think that’s incorrect or this pull request requires a review, please simply write any comment. If closed, you can revive the PR at any time and @mention a reviewer or discuss it on the dev@beam.apache.org list. Thank you for your contributions.

@github-actions github-actions bot added the stale label Jul 20, 2025
@github-actions
Copy link
Contributor

This pull request has been closed due to lack of activity. If you think that is incorrect, or the pull request requires review, you can revive the PR at any time.

@github-actions github-actions bot closed this Jul 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants