feat: Add optional prefetch hint for parsing Puffin Footer #1207
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
|
Hi, I believe this hint should be optional and we shouldn't require all users to provide it. |
|
@Xuanwo It is optional, let me change the title. Or do you mean that i should add a function like |
jonathanc-n
changed the title
Yep. I believe we should not change the |
|
@Xuanwo Thanks for the review, it is fixed! |
| pub struct FileMetadata { | ||
| pub(crate) blobs: Vec<BlobMetadata>, | ||
| #[serde(skip_serializing_if = "HashMap::is_empty")] | ||
| #[serde(default)] | ||
| pub(crate) properties: HashMap<String, String>, | ||
| /// Optional prefetch hint you can pass for retrieving footer | ||
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub(crate) prefetch_hint: Option<u8>, |
There was a problem hiding this comment.
I have concerns adding this field for two reasons:
- It looks impractical to ask user to pass in the
prefetch_hint. - This format is define by iceberg spec, and adding another field may lead to wrong file.
| /// `prefetch_hint` is used to try to fetch the entire footer in one read. If | ||
| /// the entire footer isn't fetched in one read the function will call the `read_no_prefetch` | ||
| /// option. | ||
| pub(crate) async fn read(&self, input_file: &InputFile) -> Result<FileMetadata> { |
There was a problem hiding this comment.
Suggested change
| pub(crate) async fn read(&self, input_file: &InputFile) -> Result<FileMetadata> { | |
| pub(crate) async fn read(input_file: &InputFile) -> Result<FileMetadata> { |
Suggestions:
- Keep original api
- Add anoter method
read_with_hintto implement the method with a hint.
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?
What changes are included in this PR?
Add prefetch hint for parsing puffin footer + change some docs
Are these changes tested?
Yes, unit tested