Minor: Add documentation about stream cancellation #8747
Merged
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
github-actions
bot
added
core
|
Thanks @alamb. You have clearly detailed the related areas. |
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.
Which issue does this PR close?
N/A
Rationale for this change
While discussing #8739 the behavior of stream cancellation and how to abort execution were not clear (see #8739 (comment))
It would be good to document what has been until now an implicit assumption
What changes are included in this PR?
Add documentation explaining the expecations on the stream returned from
ExecutionPlan::executeas well as add explicit documentation on how to cancel the result of callingexecute_streamand similar methods ("drop the stream").Are these changes tested?
Via doctests
Are there any user-facing changes?