Struct datafusion_common::config::CsvOptions

pub struct CsvOptions {
    pub has_header: bool,
    pub delimiter: u8,
    pub quote: u8,
    pub escape: Option<u8>,
    pub compression: CompressionTypeVariant,
    pub schema_infer_max_rec: usize,
    pub date_format: Option<String>,
    pub datetime_format: Option<String>,
    pub timestamp_format: Option<String>,
    pub timestamp_tz_format: Option<String>,
    pub time_format: Option<String>,
    pub null_value: Option<String>,
}

Options controlling CSV format

Fields

has_header: bool

delimiter: u8

quote: u8

escape: Option<u8>

compression: CompressionTypeVariant

schema_infer_max_rec: usize

date_format: Option<String>

datetime_format: Option<String>

timestamp_format: Option<String>

timestamp_tz_format: Option<String>

time_format: Option<String>

null_value: Option<String>

Implementations

impl CsvOptions

pub fn with_compression( self, compression_type_variant: CompressionTypeVariant ) -> Self

Set a limit in terms of records to scan to infer the schema

• default to DEFAULT_SCHEMA_INFER_MAX_RECORD

pub fn with_schema_infer_max_rec(self, max_rec: usize) -> Self

Set a limit in terms of records to scan to infer the schema

• default to DEFAULT_SCHEMA_INFER_MAX_RECORD

pub fn with_has_header(self, has_header: bool) -> Self

Set true to indicate that the first line is a header.

• default to true

pub fn has_header(&self) -> bool

True if the first line is a header.

pub fn with_delimiter(self, delimiter: u8) -> Self

The character separating values within a row.

• default to ‘,’

pub fn with_quote(self, quote: u8) -> Self

The quote character in a row.

• default to ‘“’

pub fn with_escape(self, escape: Option<u8>) -> Self

The escape character in a row.

• default is None

pub fn with_file_compression_type( self, compression: CompressionTypeVariant ) -> Self

Set a CompressionTypeVariant of CSV

• defaults to CompressionTypeVariant::UNCOMPRESSED

pub fn delimiter(&self) -> u8

The delimiter character.

pub fn quote(&self) -> u8

The quote character.

pub fn escape(&self) -> Option<u8>

The escape character.

Trait Implementations

impl Clone for CsvOptions

fn clone(&self) -> CsvOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConfigField for CsvOptions

fn set(&mut self, key: &str, value: &str) -> Result<()>

fn visit<V: Visit>( &self, v: &mut V, key_prefix: &str, _description: &'static str )

impl Debug for CsvOptions

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

Formats the value using the given formatter.

impl Default for CsvOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CsvOptions

fn eq(&self, other: &CsvOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&CsvOptions> for CsvWriterOptions

type Error = DataFusionError

The type returned in the event of a conversion error.

fn try_from(value: &CsvOptions) -> Result<Self>

Performs the conversion.

impl StructuralPartialEq for CsvOptions