[Docs] Document UnboundedSource in the Python I/O connector guide - #39529
Open
Eliaaazzz wants to merge 1 commit into
Open
[Docs] Document UnboundedSource in 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). |
Eliaaazzz
force-pushed
the
python-unbounded-source-doc
branch
from
July 31, 2026 12:01
8e5b2cb to
f5f2f74
Compare
Eliaaazzz
force-pushed
the
python-unbounded-source-doc
branch
from
July 31, 2026 13:10
f5f2f74 to
01821a4
Compare
The guide covered only the bounded BoundedSource and RangeTracker path. Add the UnboundedSource, UnboundedReader, and CheckpointMark sections, plus an example source and the Read and ReadFromUnboundedSource entry points. Group the source classes under "Implementing the Source subclass" and the reader classes under "Implementing the RangeTracker and UnboundedReader subclasses" so the page nests the same way as the Java guide.
Eliaaazzz
force-pushed
the
python-unbounded-source-doc
branch
from
July 31, 2026 13:12
01821a4 to
ff50ad4
Compare
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.
Documents
UnboundedSourcein the Python I/O connector development guide, mirroring theUnboundedSourcecoverage in the Java guide.The guide currently describes only the bounded
BoundedSource/RangeTrackerpath, so theUnboundedSource,UnboundedReader, andCheckpointMarkclasses added in #38724 are undocumented on the website.What changes
UnboundedSourcealongsideBoundedSource, and names the reader and checkpoint-mark classes each one needs.split,create_reader,get_checkpoint_mark_coder, the optionaldefault_output_coder, and the absence of a per-record dedup hook (useDeduplicateafter the read).start,advance,get_current,get_current_timestamp,get_watermark,get_checkpoint_mark,close, including the distinction between "no data right now" and aMAX_TIMESTAMPend of stream.create_reader, and the idempotence requirement onfinalize_checkpoint.beam.io.Read, and thepoll_interval/max_records_per_bundle/max_read_time_secondsknobs onReadFromUnboundedSource.The example was run on the DirectRunner against a fake queue before being added:
beam.io.Read(QueueSource(...))emits the expected records and, thanks to thedefault_output_coderoverride, types the outputPCollectionasbytes.This replaces the earlier revision of this PR, which described how to write an unbounded Splittable DoFn instead of documenting the
UnboundedSourceAPI.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