Skip to content

Commit

Permalink
Document how to write bloom filters
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb committed Aug 8, 2024
1 parent cc6f9bf commit d51c697
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions parquet/src/file/metadata/writer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,11 @@ impl<'a, W: Write> ThriftMetadataWriter<'a, W> {
/// BloomFilters stored in separate structures whose locations are stored as
/// offsets from the beginning of the file.
///
/// Note: this writer does not directly write BloomFilters. In order to write
/// BloomFilters, write the bloom filters into the buffer before creating the
/// metadata writer. Then set the corresponding `bloom_filter_offset` and
/// `bloom_filter_length` on [`ColumnChunkMetaData`] passed to this writer.
///
/// # Output Format
///
/// The format of the metadata is as follows:
Expand All @@ -218,6 +223,7 @@ impl<'a, W: Write> ThriftMetadataWriter<'a, W> {
/// 5. Parquet Magic Bytes (4 bytes)
///
/// [`FileMetaData`]: crate::format::FileMetaData
/// [`ColumnChunkMetaData`]: crate::file::metadata::ColumnChunkMetaData
///
/// ```text
/// ┌──────────────────────┐
Expand Down

0 comments on commit d51c697

Please sign in to comment.