apache / apache/beam

BoundedReadFromUnboundedSource should be strongly discouraged

Open
#18,382 0 comments 0 reactions 0 assignees View on GitHub
bug core java P3
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
2d 2h
Merged PRs (30d)
205

Description

The outputs of reading from a `BoundedReadFromUnboundedSource` are not generally well defined. This should be explicitly noted in the documentation. Potentially, it should be deprecated.

It is also worth considering removing the finalizeCheckpoint calls within the read, to minimally mutate the target source.

Imported from Jira [BEAM-2307](https://issues.apache.org/jira/browse/BEAM-2307). Original Jira may contain additional context.
Reported by: tgroh.

Contributor guide

Open the contributing guide

Research direction

Start by locating BoundedReadFromUnboundedSource and reading its existing documentation. Review the original Jira issue for context, then inspect the finalizeCheckpoint calls mentioned in the issue. Done means the documentation clearly warns about undefined outputs and the project’s decision on deprecation and checkpoint finalization is recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
stream-processing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.