Struct FileMetaData

pub struct FileMetaData {
    version: i32,
    num_rows: i64,
    created_by: Option<String>,
    key_value_metadata: Option<Vec<KeyValue>>,
    schema_descr: SchemaDescPtr,
    column_orders: Option<Vec<ColumnOrder>>,
}

File level metadata for a Parquet file.

Includes the version of the file, metadata, number of rows, schema, and column orders

Fields

version: i32

num_rows: i64

created_by: Option<String>

key_value_metadata: Option<Vec<KeyValue>>

schema_descr: SchemaDescPtr

column_orders: Option<Vec<ColumnOrder>>

Implementations

impl FileMetaData

pub fn new( version: i32, num_rows: i64, created_by: Option<String>, key_value_metadata: Option<Vec<KeyValue>>, schema_descr: SchemaDescPtr, column_orders: Option<Vec<ColumnOrder>>, ) -> Self

Creates new file metadata.

pub fn version(&self) -> i32

Returns version of this file.

pub fn num_rows(&self) -> i64

Returns number of rows in the file.

pub fn created_by(&self) -> Option<&str>

String message for application that wrote this file.

This should have the following format: <application> version <application version> (build <application build hash>).

parquet-mr version 1.8.0 (build 0fda28af84b9746396014ad6a415b90592a98b3b)

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

Returns key_value_metadata of this file.

pub fn schema(&self) -> &SchemaType

Returns Parquet Type that describes schema in this file.

pub fn schema_descr(&self) -> &SchemaDescriptor

Returns a reference to schema descriptor.

pub fn schema_descr_ptr(&self) -> SchemaDescPtr

Returns reference counted clone for schema descriptor.

pub fn column_orders(&self) -> Option<&Vec<ColumnOrder>>

Column (sort) order used for min and max values of each column in this file.

Each column order corresponds to one column, determined by its position in the list, matching the position of the column in the schema.

When None is returned, there are no column orders available, and each column should be assumed to have undefined (legacy) column order.

pub fn column_order(&self, i: usize) -> ColumnOrder

Returns column order for ith column in this file. If column orders are not available, returns undefined (legacy) column order.

Trait Implementations

impl Clone for FileMetaData

fn clone(&self) -> FileMetaData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileMetaData

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

Formats the value using the given formatter.

impl HeapSize for FileMetaData

fn heap_size(&self) -> usize

Return the size of any bytes allocated on the heap by this object, including heap memory in those structures

impl PartialEq for FileMetaData

fn eq(&self, other: &FileMetaData) -> 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 StructuralPartialEq for FileMetaData