polars_parquet_format

Struct ColumnMetaData

Source
pub struct ColumnMetaData {
Show 16 fields pub type_: Type, pub encodings: Vec<Encoding>, pub path_in_schema: Vec<String>, pub codec: CompressionCodec, pub num_values: i64, pub total_uncompressed_size: i64, pub total_compressed_size: i64, pub key_value_metadata: Option<Vec<KeyValue>>, pub data_page_offset: i64, pub index_page_offset: Option<i64>, pub dictionary_page_offset: Option<i64>, pub statistics: Option<Statistics>, pub encoding_stats: Option<Vec<PageEncodingStats>>, pub bloom_filter_offset: Option<i64>, pub bloom_filter_length: Option<i32>, pub size_statistics: Option<SizeStatistics>,
}
Expand description

Description for column metadata

Fields§

§type_: Type

Type of this column *

§encodings: Vec<Encoding>

Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *

§path_in_schema: Vec<String>

Path in schema *

§codec: CompressionCodec

Compression codec *

§num_values: i64

Number of values in this column *

§total_uncompressed_size: i64

total byte size of all uncompressed pages in this column chunk (including the headers) *

§total_compressed_size: i64

total byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *

§key_value_metadata: Option<Vec<KeyValue>>

Optional key/value metadata *

§data_page_offset: i64

Byte offset from beginning of file to first data page *

§index_page_offset: Option<i64>

Byte offset from beginning of file to root index page *

§dictionary_page_offset: Option<i64>

Byte offset from the beginning of file to first (only) dictionary page *

§statistics: Option<Statistics>

optional statistics for this column chunk

§encoding_stats: Option<Vec<PageEncodingStats>>

Set of all encodings used for pages in this column chunk. This information can be used to determine if all data pages are dictionary encoded for example *

§bloom_filter_offset: Option<i64>

Byte offset from beginning of file to Bloom filter data. *

§bloom_filter_length: Option<i32>

Size of Bloom filter data including the serialized header, in bytes. Added in 2.10 so readers may not read this field from old files and it can be obtained after the BloomFilterHeader has been deserialized. Writers should write this field so readers can read the bloom filter in a single I/O.

§size_statistics: Option<SizeStatistics>

Optional statistics to help estimate total memory when converted to in-memory representations. The histograms contained in these statistics can also be useful in some cases for more fine-grained nullability/list length filter pushdown.

Implementations§

Source§

impl ColumnMetaData

Source

pub fn new<F8, F10, F11, F12, F13, F14, F15, F16>( type_: Type, encodings: Vec<Encoding>, path_in_schema: Vec<String>, codec: CompressionCodec, num_values: i64, total_uncompressed_size: i64, total_compressed_size: i64, key_value_metadata: F8, data_page_offset: i64, index_page_offset: F10, dictionary_page_offset: F11, statistics: F12, encoding_stats: F13, bloom_filter_offset: F14, bloom_filter_length: F15, size_statistics: F16, ) -> ColumnMetaData

Source

pub fn read_from_in_protocol<T: TInputProtocol>( i_prot: &mut T, ) -> Result<ColumnMetaData>

Source

pub fn write_to_out_protocol<T: TOutputProtocol>( &self, o_prot: &mut T, ) -> Result<usize>

Trait Implementations§

Source§

impl Clone for ColumnMetaData

Source§

fn clone(&self) -> ColumnMetaData

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ColumnMetaData

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for ColumnMetaData

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ColumnMetaData

Source§

fn cmp(&self, other: &ColumnMetaData) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ColumnMetaData

Source§

fn eq(&self, other: &ColumnMetaData) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for ColumnMetaData

Source§

fn partial_cmp(&self, other: &ColumnMetaData) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl ReadThrift for ColumnMetaData

Source§

impl Eq for ColumnMetaData

Source§

impl StructuralPartialEq for ColumnMetaData

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.