Skip to content

Deprecate ParquetIO.withProjection (#20770) - #40043

Open
nitinware wants to merge 1 commit into
apache:masterfrom
nitinware:deprecate-parquet-withprojection
Open

Deprecate ParquetIO.withProjection (#20770)#40043
nitinware wants to merge 1 commit into
apache:masterfrom
nitinware:deprecate-parquet-withprojection

Conversation

@nitinware

Copy link
Copy Markdown

Deprecates ParquetIO.Read#withProjection and ParquetIO.ReadFiles#withProjection.

Both helpers duplicate functionality already available upstream via
AvroReadSupport.setRequestedProjection / AvroReadSupport.setAvroReadSchema,
and the required encoderSchema parameter is redundant. Users can pass a
configured Hadoop Configuration via withConfiguration(...) for the same
effect.

This PR:

  • Adds @Deprecated + Javadoc @deprecated on both withProjection methods
    pointing at the recommended API.
  • Updates the class-level Javadoc example accordingly.

No behavior change; the methods still work exactly as before.

Fixes #20770

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:

  • [ x ] 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.
  • [ x ] Update CHANGES.md with noteworthy changes.
  • [ x ] 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.

  The withProjection(projectionSchema, encoderSchema) helpers on
  ParquetIO.Read and ParquetIO.ReadFiles duplicate functionality already
  available upstream via AvroReadSupport.setRequestedProjection and
  AvroReadSupport.setAvroReadSchema. The encoderSchema parameter is also
  redundant. Users should configure projection on a Hadoop Configuration
  and pass it via withConfiguration(...) instead.

  This change adds @deprecated + Javadoc pointing at the recommended
  upstream API. Behavior is unchanged; existing pipelines continue to
  compile and run.

  Fixes apache#20770
@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @ahmedabu98 for label java.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

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.

Deprecate .withProjection from ParquetIO

1 participant