[FLINK-37162] Add sinks.md to describe Flink's Data Sink API. #26013
+245
−4
Conversation
This file contains 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
davidradl
reviewed
Jan 20, 2025
davidradl
reviewed
Jan 20, 2025
davidradl
reviewed
Jan 20, 2025
|
|
||
| The `SinkWriter` API only has three methods: | ||
| - write(InputT element, Context context): Adds an element to the writer. | ||
| - flush(boolean endOfInput): Called on checkpoint or end of input so that the writer to flush all pending data for at-least-once. |
There was a problem hiding this comment.
nit: better English might be
Called on checkpoint or end of the input, setting this flag causes the writer to flush all pending data for at-least-once.
I am unsure about this comment, and what the writer is supposed to so with the flag set or on set. I assume the writer needs to check for at-least-once. For exactly-once - how does flush work?
davidradl
reviewed
Jan 20, 2025
davidradl
reviewed
Jan 20, 2025
|
|
||
| ### SupportsCommitter | ||
|
|
||
| The {{< gh_link file="flink-core/src/main/java/org/apache/flink/api/connector/sink2/SupportsCommitter.java" name="SupportsCommitter" >}} interface is used to indicate that the sink supports exactly-once semantics using a two-phase commit protocol. |
There was a problem hiding this comment.
it would be useful to point to how Flink is implementing 2 phase commit in the flink docs. Maybe this is another PR
davidradl
reviewed
Jan 20, 2025
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.
What is the purpose of the change
Add doc for Sink API.
Brief change log
Add doc for Sink API and remove legacy doc about SourceFunction.
Verifying this change
Don't need.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (no)Documentation