Skip to content

Commit d51c697

Browse files
committed
Document how to write bloom filters
1 parent cc6f9bf commit d51c697

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

parquet/src/file/metadata/writer.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,11 @@ impl<'a, W: Write> ThriftMetadataWriter<'a, W> {
207207
/// BloomFilters stored in separate structures whose locations are stored as
208208
/// offsets from the beginning of the file.
209209
///
210+
/// Note: this writer does not directly write BloomFilters. In order to write
211+
/// BloomFilters, write the bloom filters into the buffer before creating the
212+
/// metadata writer. Then set the corresponding `bloom_filter_offset` and
213+
/// `bloom_filter_length` on [`ColumnChunkMetaData`] passed to this writer.
214+
///
210215
/// # Output Format
211216
///
212217
/// The format of the metadata is as follows:
@@ -218,6 +223,7 @@ impl<'a, W: Write> ThriftMetadataWriter<'a, W> {
218223
/// 5. Parquet Magic Bytes (4 bytes)
219224
///
220225
/// [`FileMetaData`]: crate::format::FileMetaData
226+
/// [`ColumnChunkMetaData`]: crate::file::metadata::ColumnChunkMetaData
221227
///
222228
/// ```text
223229
/// ┌──────────────────────┐

0 commit comments

Comments
 (0)