docs: clarify stdin store buffers on construction, not first use#23060
Merged
Conversation
Address review feedback on apache#22839: the `stdin://` store reads and buffers all of standard input eagerly when the store is constructed, not lazily on first use. Reword the get_or_create doc comment to say so.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Follow-up to #22839 (stdin support in
datafusion-cli), addressing post-merge review feedback from @alamb. No separate issue.Rationale for this change
In the review of #22839, @alamb noted that the
StdinUtils::get_or_createdoc comment was technically imprecise:The
stdin://store reads and buffers all of standard input eagerly when the store is constructed (object_store→read_to_end→in_memory_object_store), not lazily on first use of the store. The doc comment said "on first use", which suggests lazy buffering.What changes are included in this PR?
Reword the first sentence of the
get_or_createdoc comment to say the store buffers all of standard input "when the store is first constructed" instead of "on first use". Doc-comment only; no behavior change.Are these changes tested?
No code change — documentation only. Existing tests in
object_storage/stdin.rsare unaffected.Are there any user-facing changes?
No.