[MINOR][DOCS] Update foreachbatch docs #50188
Open
+14
−9
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
- Cleaned / clarified up wording - Changed example to read value, not update it The new example makes it clear that in Spark Connect, the value is not available. In the previous example, it wasn't clear whether the `my_value` was available to the foreachbatch function, or if it was simply not returning the updated value back to the client.
fbertsch
changed the title
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.
The new example makes it clear that in Spark Connect, the value is not available. In the previous example, it wasn't clear whether the
my_valuewas available to the foreachbatch function, or if it was simply not returning the updated value back to the client.What changes were proposed in this pull request?
The new example makes it clear that in Spark Connect, the value is not available. In the previous example, it wasn't clear whether the
my_valuewas available to the foreachbatch function, or if it was simply not returning the updated value back to the client.Why are the changes needed?
To help clarify foreachBatch behavior, especially w/ Spark Connect.
Does this PR introduce any user-facing change?
Yes, docs.
How was this patch tested?
I tested the example function using Spark Connect. It failed with the example given.
Was this patch authored or co-authored using generative AI tooling?
No.