Document when the ParquetRecordBatchReader will re-read metadata #5887
Conversation
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
alamb
commented
Jun 14, 2024
| /// construct multiple separate readers, for example, to distribute readers | ||
| /// across multiple threads | ||
| /// | ||
| /// 2. Using a cached copy of the [`ParquetMetadata`] rather than reading it |
There was a problem hiding this comment.
I also added the second and important usecase of not re-reading the metadata on subsequent reads
|
Cheaply clonaable is good :-) |
tustvold
approved these changes
Jun 14, 2024
|
Thank you for the reviews |
# for free
to join this conversation on GitHub.
Already have an account?
# 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 working on apache/datafusion#10701 and discussing with @marsupialtail I finally figured out how to use the page index with cached parquet metadata without extra object store requests.
However, I think it is quite tricky and subtle, so it would be good to document this in the parquet crate itself so I don't have to go spelunking in the future.
What changes are included in this PR?
Document when
ArrowReaderMetadata::loadwill make object store calls when using the page indexAre there any user-facing changes?
Just docs