Struct parquet::file::metadata::ParquetMetaDataBuilder

pub struct ParquetMetaDataBuilder(/* private fields */);

A builder for creating / manipulating ParquetMetaData

Example creating a new ParquetMetaData

 // Create a new builder given the file metadata
 let file_metadata = get_file_metadata();
 // Create a row group
 let row_group = RowGroupMetaData::builder(file_metadata.schema_descr_ptr())
    .set_num_rows(100)
    // ... (A real row group needs more than just the number of rows)
    .build()
    .unwrap();
 // Create the final metadata
 let metadata: ParquetMetaData = ParquetMetaDataBuilder::new(file_metadata)
   .add_row_group(row_group)
   .build();

Example modifying an existing ParquetMetaData

// Modify the metadata so only the last RowGroup remains
let metadata: ParquetMetaData = load_metadata();
let mut builder = metadata.into_builder();

// Take existing row groups to modify
let mut row_groups = builder.take_row_groups();
let last_row_group = row_groups.pop().unwrap();

let metadata = builder
  .add_row_group(last_row_group)
  .build();

Implementations

impl ParquetMetaDataBuilder

pub fn new(file_meta_data: FileMetaData) -> Self

Create a new builder from a file metadata, with no row groups

pub fn new_from_metadata(metadata: ParquetMetaData) -> Self

Create a new builder from an existing ParquetMetaData

pub fn add_row_group(self, row_group: RowGroupMetaData) -> Self

Adds a row group to the metadata

pub fn set_row_groups(self, row_groups: Vec<RowGroupMetaData>) -> Self

Sets all the row groups to the specified list

pub fn take_row_groups(&mut self) -> Vec<RowGroupMetaData>

Takes ownership of the row groups in this builder, and clears the list of row groups.

This can be used for more efficient creation of a new ParquetMetaData from an existing one.

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

Return a reference to the current row groups

pub fn set_column_index(self, column_index: Option<ParquetColumnIndex>) -> Self

Sets the column index

pub fn take_column_index(&mut self) -> Option<ParquetColumnIndex>

Returns the current column index from the builder, replacing it with None

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

Return a reference to the current column index, if any

pub fn set_offset_index(self, offset_index: Option<ParquetOffsetIndex>) -> Self

Sets the offset index

pub fn take_offset_index(&mut self) -> Option<ParquetOffsetIndex>

Returns the current offset index from the builder, replacing it with None

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

Return a reference to the current offset index, if any

pub fn build(self) -> ParquetMetaData

Creates a new ParquetMetaData from the builder

Trait Implementations

impl From<ParquetMetaData> for ParquetMetaDataBuilder

fn from(meta_data: ParquetMetaData) -> Self

Converts to this type from the input type.