[Docs] Add unbounded source guidance to the Python I/O connector guide - #39529
Open
Eliaaazzz wants to merge 1 commit into
Open
[Docs] Add unbounded source guidance to the Python I/O connector guide#39529Eliaaazzz wants to merge 1 commit into
Eliaaazzz wants to merge 1 commit into
Conversation
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
Contributor
|
Assigning reviewers: R: @damccorm for label website. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a "Reading from an unbounded source" section to the Python I/O connector development guide.
The guide currently documents only the bounded
BoundedSource/RangeTrackerpath and does not say how to build an unbounded (streaming) source in Python. The Java guide covers this with itsUnboundedSource/UnboundedReadersections. The Python SDK has noUnboundedSourceclass; an unbounded source is written as a Splittable DoFn, but the I/O connector guide, which is where the Java unbounded documentation lives, had no Python counterpart.What changes
Sourceinterface is bounded only, linking to the new section.@beam.DoFn.unbounded_per_element(),RestrictionParam,WatermarkEstimatorParam,try_claim,defer_remainder).UnboundedSource/UnboundedReaderconcern in the Java guide to its Splittable DoFn equivalent: initial and dynamic splitting, checkpointing through residual restrictions, resuming throughdefer_remainder, watermark estimators, deduplication, and drain throughRestrictionProvider.truncate.PeriodicImpulse/PeriodicSequenceand the experimentalWatchtransform added in [Python] Add Watch transform with growth_of polling SDF #39023.The example follows the same self-checkpoint pattern as the
SDF_UserInitiatedCheckpointsnippet in the programming guide andperiodicsequence.py: callrestriction_tracker.defer_remainder(...)and return, which is the mechanism the portable runners implement.Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
R: @username).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, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.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