Struct parquet::file::properties::WriterProperties

pub struct WriterProperties { /* private fields */ }

Writer properties.

All properties except the key-value metadata are immutable, use WriterPropertiesBuilder to assemble these properties.

Implementations

impl WriterProperties

pub fn builder() -> WriterPropertiesBuilder

Returns builder for writer properties with default values.

pub fn data_pagesize_limit(&self) -> usize

Returns data page size limit.

Note: this is a best effort limit based on the write batch size

pub fn dictionary_pagesize_limit(&self) -> usize

Returns dictionary page size limit.

Note: this is a best effort limit based on the write batch size

pub fn data_page_row_count_limit(&self) -> usize

Returns the maximum page row count

This can be used to limit the number of rows within a page to yield better page pruning

Note: this is a best effort limit based on the write batch size

pub fn write_batch_size(&self) -> usize

Returns configured batch size for writes.

When writing a batch of data, this setting allows to split it internally into smaller batches so we can better estimate the size of a page currently being written.

pub fn max_row_group_size(&self) -> usize

Returns maximum number of rows in a row group.

pub fn writer_version(&self) -> WriterVersion

Returns configured writer version.

pub fn created_by(&self) -> &str

Returns created_by string.

pub fn key_value_metadata(&self) -> Option<&Vec<KeyValue>>

Returns key_value_metadata KeyValue pairs.

pub fn sorting_columns(&self) -> Option<&Vec<SortingColumn>>

Returns sorting columns.

pub fn dictionary_data_page_encoding(&self) -> Encoding

Returns encoding for a data page, when dictionary encoding is enabled. This is not configurable.

pub fn dictionary_page_encoding(&self) -> Encoding

Returns encoding for dictionary page, when dictionary encoding is enabled. This is not configurable.

pub fn encoding(&self, col: &ColumnPath) -> Option<Encoding>

Returns encoding for a column, if set. In case when dictionary is enabled, returns fallback encoding.

If encoding is not set, then column writer will choose the best encoding based on the column type.

pub fn compression(&self, col: &ColumnPath) -> Compression

Returns compression codec for a column.

pub fn dictionary_enabled(&self, col: &ColumnPath) -> bool

Returns true if dictionary encoding is enabled for a column.

pub fn statistics_enabled(&self, col: &ColumnPath) -> EnabledStatistics

Returns true if statistics are enabled for a column.

pub fn max_statistics_size(&self, col: &ColumnPath) -> usize

Returns max size for statistics. Only applicable if statistics are enabled.

pub fn bloom_filter_properties( &self, col: &ColumnPath ) -> Option<&BloomFilterProperties>

Returns the BloomFilterProperties for the given column

Returns None if bloom filter is disabled

Trait Implementations

impl Clone for WriterProperties

fn clone(&self) -> WriterProperties

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WriterProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.