Struct parquet::format::ColumnMetaData

pub struct ColumnMetaData {

    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>,
}

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

impl ColumnMetaData

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

where F8: Into<Option<Vec<KeyValue>>>, F10: Into<Option<i64>>, F11: Into<Option<i64>>, F12: Into<Option<Statistics>>, F13: Into<Option<Vec<PageEncodingStats>>>, F14: Into<Option<i64>>, F15: Into<Option<i32>>, F16: Into<Option<SizeStatistics>>,

Trait Implementations

impl Clone for ColumnMetaData

fn clone(&self) -> ColumnMetaData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnMetaData

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

Formats the value using the given formatter.

impl Hash for ColumnMetaData

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ColumnMetaData

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ColumnMetaData

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ColumnMetaData

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TSerializable for ColumnMetaData

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

Reads the struct from the input Thrift protocol

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

Writes the struct to the output Thrift protocol

impl Eq for ColumnMetaData

impl StructuralPartialEq for ColumnMetaData