Struct parquet::file::properties::WriterProperties
source · pub struct WriterProperties { /* private fields */ }Expand description
Writer properties.
All properties except the key-value metadata are immutable,
use WriterPropertiesBuilder to assemble these properties.
Implementations
sourceimpl WriterProperties
impl WriterProperties
sourcepub fn builder() -> WriterPropertiesBuilder
pub fn builder() -> WriterPropertiesBuilder
Returns builder for writer properties with default values.
sourcepub fn data_pagesize_limit(&self) -> usize
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
sourcepub fn dictionary_pagesize_limit(&self) -> usize
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
sourcepub fn data_page_row_count_limit(&self) -> usize
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
sourcepub fn write_batch_size(&self) -> usize
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.
sourcepub fn max_row_group_size(&self) -> usize
pub fn max_row_group_size(&self) -> usize
Returns maximum number of rows in a row group.
sourcepub fn writer_version(&self) -> WriterVersion
pub fn writer_version(&self) -> WriterVersion
Returns configured writer version.
sourcepub fn created_by(&self) -> &str
pub fn created_by(&self) -> &str
Returns created_by string.
sourcepub fn key_value_metadata(&self) -> Option<&Vec<KeyValue>>
pub fn key_value_metadata(&self) -> Option<&Vec<KeyValue>>
Returns key_value_metadata KeyValue pairs.
sourcepub fn dictionary_data_page_encoding(&self) -> Encoding
pub fn dictionary_data_page_encoding(&self) -> Encoding
Returns encoding for a data page, when dictionary encoding is enabled. This is not configurable.
sourcepub fn dictionary_page_encoding(&self) -> Encoding
pub fn dictionary_page_encoding(&self) -> Encoding
Returns encoding for dictionary page, when dictionary encoding is enabled. This is not configurable.
sourcepub fn encoding(&self, col: &ColumnPath) -> Option<Encoding>
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.
sourcepub fn compression(&self, col: &ColumnPath) -> Compression
pub fn compression(&self, col: &ColumnPath) -> Compression
Returns compression codec for a column.
sourcepub fn dictionary_enabled(&self, col: &ColumnPath) -> bool
pub fn dictionary_enabled(&self, col: &ColumnPath) -> bool
Returns true if dictionary encoding is enabled for a column.
sourcepub fn statistics_enabled(&self, col: &ColumnPath) -> EnabledStatistics
pub fn statistics_enabled(&self, col: &ColumnPath) -> EnabledStatistics
Returns true if statistics are enabled for a column.
sourcepub fn max_statistics_size(&self, col: &ColumnPath) -> usize
pub fn max_statistics_size(&self, col: &ColumnPath) -> usize
Returns max size for statistics. Only applicable if statistics are enabled.
Trait Implementations
sourceimpl Clone for WriterProperties
impl Clone for WriterProperties
sourcefn clone(&self) -> WriterProperties
fn clone(&self) -> WriterProperties
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more