parquet::file::metadata

Struct ParquetMetaData

Source
pub struct ParquetMetaData { /* private fields */ }
Expand description

Parsed metadata for a single Parquet file

This structure is stored in the footer of Parquet files, in the format defined by parquet.thrift.

§Overview

The fields of this structure are:

This structure is read by the various readers in this crate or can be read directly from a file using the ParquetMetaDataReader struct.

See the ParquetMetaDataBuilder to create and modify this structure.

Implementations§

Source§

impl ParquetMetaData

Source

pub fn new( file_metadata: FileMetaData, row_groups: Vec<RowGroupMetaData>, ) -> Self

Creates Parquet metadata from file metadata and a list of row group metadata

Source

pub fn new_with_page_index( file_metadata: FileMetaData, row_groups: Vec<RowGroupMetaData>, column_index: Option<ParquetColumnIndex>, offset_index: Option<ParquetOffsetIndex>, ) -> Self

👎Deprecated: Use ParquetMetaDataBuilder

Creates Parquet metadata from file metadata, a list of row group metadata, and the column index structures.

Source

pub fn into_builder(self) -> ParquetMetaDataBuilder

Convert this ParquetMetaData into a ParquetMetaDataBuilder

Source

pub fn file_metadata(&self) -> &FileMetaData

Returns file metadata as reference.

Source

pub fn num_row_groups(&self) -> usize

Returns number of row groups in this file.

Source

pub fn row_group(&self, i: usize) -> &RowGroupMetaData

Returns row group metadata for ith position. Position should be less than number of row groups num_row_groups.

Source

pub fn row_groups(&self) -> &[RowGroupMetaData]

Returns slice of row groups in this file.

Source

pub fn page_indexes(&self) -> Option<&ParquetColumnIndex>

👎Deprecated: Use Self::column_index

Returns page indexes in this file.

Source

pub fn column_index(&self) -> Option<&ParquetColumnIndex>

Returns the column index for this file if loaded

Returns None if the parquet file does not have a ColumnIndex or ArrowReaderOptions::with_page_index was set to false.

Source

pub fn offset_indexes(&self) -> Option<&ParquetOffsetIndex>

👎Deprecated: Use Self::offset_index

Returns the offset index for this file if loaded

Source

pub fn offset_index(&self) -> Option<&ParquetOffsetIndex>

Returns offset indexes in this file, if loaded

Returns None if the parquet file does not have a OffsetIndex or ArrowReaderOptions::with_page_index was set to false.

Source

pub fn memory_size(&self) -> usize

Estimate of the bytes allocated to store ParquetMetadata

§Notes:
  1. Includes size of self

  2. Includes heap memory for sub fields such as FileMetaData and RowGroupMetaData.

  3. Includes memory from shared pointers (e.g. SchemaDescPtr). This means memory_size will over estimate the memory size if such pointers are shared.

  4. Does not include any allocator overheads

Trait Implementations§

Source§

impl Clone for ParquetMetaData

Source§

fn clone(&self) -> ParquetMetaData

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 ParquetMetaData

Source§

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

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

impl From<ParquetMetaData> for ParquetMetaDataBuilder

Source§

fn from(meta_data: ParquetMetaData) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ParquetMetaData

Source§

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

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 u8)

🔬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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,