docs: add sizing explanation to bloom filter docs in parquet #5705
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
Added documentation detailing the sizing of bloom filters in the parquet crate.
hiltontj
commented
May 2, 2024
hiltontj
commented
May 2, 2024
Comment on lines
+45
to
+49
| //! ```text | ||
| //! b = NP2(m/8) / 32 | ||
| //! ``` | ||
| //! | ||
| //! Where, `NP2` denotes *the next power of two*, and `m` is divided by 8 to be represented as bytes. |
There was a problem hiding this comment.
There may be a more idiomatic way of expressing the next power of two as a function than NP2.
There was a problem hiding this comment.
🤷 I don't know of one off the top of my head
|
Looks like Clippy is unhappy after 1.78. I will likely wait for that to get fixed upstream and then merge/rebase. |
alamb
reviewed
May 2, 2024
Comment on lines
+45
to
+49
| //! ```text | ||
| //! b = NP2(m/8) / 32 | ||
| //! ``` | ||
| //! | ||
| //! Where, `NP2` denotes *the next power of two*, and `m` is divided by 8 to be represented as bytes. |
There was a problem hiding this comment.
🤷 I don't know of one off the top of my head
8 tasks
|
I believe the clippy failure is unrelated (it is due to the new version of rust, nothing in this PR) |
Updated the bloom filter module doc comment to clarify that the metadata stores the offset/length of the bloom filter, and not the bloom filter in its entirety. Co-authored-by: Andrew Lamb <[email protected]>
|
PR to fix clippy is here: #5710 |
|
I merged up from main to get the clippy fixes The archery integration test failure does not appear to be related: #5719 |
|
Thanks again @hiltontj ! |
|
Thanks for closing it out @alamb! |
This pull request was closed.
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.
Added documentation detailing the sizing of bloom filters in the parquet crate.
Which issue does this PR close?
There is currently no issue for this change.
Rationale for this change
There is a storage penalty for using bloom filters in parquet, so I felt having the explanation of how they are sized, based on the chosen FPP and NDV parameters, would be helpful to users.
What changes are included in this PR?
This only includes documentation changes to the
bloom_filtermodule within theparquetcrate.Are there any user-facing changes?
This is a documentation change, so will be user-facing.