Struct datafusion_common::file_options::csv_writer::CsvWriterOptions

pub struct CsvWriterOptions {
    pub writer_options: WriterBuilder,
    pub compression: CompressionTypeVariant,
    pub has_header: bool,
}

Options for writing CSV files

Fields

writer_options: WriterBuilder

Struct from the arrow crate which contains all csv writing related settings

compression: CompressionTypeVariant

Compression to apply after ArrowWriter serializes RecordBatches. This compression is applied by DataFusion not the ArrowWriter itself.

has_header: bool

Indicates whether WriterBuilder.has_header() is set to true. This is duplicative as WriterBuilder also stores this information. However, WriterBuilder does not allow public read access to the has_header parameter.

Implementations

impl CsvWriterOptions

pub fn new( writer_options: WriterBuilder, compression: CompressionTypeVariant ) -> Self

Trait Implementations

impl Clone for CsvWriterOptions

fn clone(&self) -> CsvWriterOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsvWriterOptions

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

Formats the value using the given formatter.

impl TryFrom<(&ConfigOptions, &StatementOptions)> for CsvWriterOptions

type Error = DataFusionError

The type returned in the event of a conversion error.

fn try_from(value: (&ConfigOptions, &StatementOptions)) -> Result<Self>

Performs the conversion.