Struct FileWriter

pub struct FileWriter<W: Write> { /* private fields */ }

An interface to write a parquet file. Use start to write the header, write to write a row group, and end to write the footer.

Implementations

impl<W: Write> FileWriter<W>

pub fn options(&self) -> &WriteOptions

The options assigned to the file

pub fn schema(&self) -> &SchemaDescriptor

The SchemaDescriptor assigned to this file

pub fn metadata(&self) -> Option<&ThriftFileMetadata>

Returns the ThriftFileMetadata. This is Some iff the Self::end has been called.

This is used to write the metadata as a separate Parquet file, usually when data is partitioned across multiple files

impl<W: Write> FileWriter<W>

pub fn new( writer: W, schema: SchemaDescriptor, options: WriteOptions, created_by: Option<String>, ) -> Self

Returns a new FileWriter.

pub fn write<E>( &mut self, row_group: RowGroupIterColumns<'_, E>, ) -> ParquetResult<()>

where ParquetError: From<E>, E: Error,

Writes a row group to the file.

This call is IO-bounded

pub fn end( &mut self, key_value_metadata: Option<Vec<KeyValue>>, ) -> ParquetResult<u64>

Writes the footer of the parquet file. Returns the total size of the file and the underlying writer.

pub fn into_inner(self) -> W

Returns the underlying writer.

pub fn into_inner_and_metadata(self) -> (W, ThriftFileMetadata)

Returns the underlying writer and ThriftFileMetadata

Panics

This function panics if Self::end has not yet been called