Minor: Add documentation + diagrams for ExternalSorter #7179
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
This was referenced Aug 2, 2023
|
@yjshen or @Dandandan I don't know if you might have time to review this PR, but if so I would appreciate it |
yjshen
approved these changes
Aug 3, 2023
| /// [`Self::insert_batch`] as a stream of [`RecordBatch`]es. | ||
| /// | ||
| /// This may be an in memory sort/merge if all input fit into memory, or | ||
| /// a streaming merge from spill files on disk. |
There was a problem hiding this comment.
This process could either be an in-memory sort/merge if all the input fits into memory or a combined streaming merge incorporating both in-memory batches and data from spill files on disk.
Co-authored-by: Yijie Shen <henry.yijieshen@gmail.com>
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?
Part of #5885
Rationale for this change
While working on #5885 I have studied this code more carefully and wanted to document how it works (which is part of how I convince myself I understand the code -- if I can document it)
What changes are included in this PR?
Doc strings and ASCII diagrams
Are these changes tested?
N/A
Are there any user-facing changes?
No