docs: Add additional info about memory reservation to the doc of MemoryPool #14789
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
Kontinuation
changed the title
alamb
approved these changes
Feb 20, 2025
There was a problem hiding this comment.
Thank you @Kontinuation
I think this is a very nice and clear addition
xudong963
approved these changes
Feb 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.
Which issue does this PR close?
This is not related to an issue. It is requested by this comment: #14644 (comment)
Rationale for this change
There's a convention that ExecutionPlans do not reserve memory for the batches it produces, but it is not explicitly stated in the doc. We should explicitly point out those conventions in the doc to make it clear.
What changes are included in this PR?
This change clarifies the general conventions that ExecutionPlans need to follow when using MemoryPool: memory for output batches are reserved by their consumers rather than their producers.
Are these changes tested?
N/A for doc changes.
Are there any user-facing changes?
No