Struct datafusion::common::config::CsvOptions

pub struct CsvOptions {

    pub has_header: Option<bool>,
    pub delimiter: u8,
    pub quote: u8,
    pub terminator: Option<u8>,
    pub escape: Option<u8>,
    pub double_quote: Option<bool>,
    pub newlines_in_values: Option<bool>,
    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>,
    pub comment: Option<u8>,
}

Options controlling CSV format

Fields

has_header: Option<bool>

Specifies whether there is a CSV header (i.e. the first line consists of is column names). The value None indicates that the configuration should be consulted.

delimiter: u8

quote: u8

terminator: Option<u8>

escape: Option<u8>

double_quote: Option<bool>

newlines_in_values: Option<bool>

Specifies whether newlines in (quoted) values are supported.

Parsing newlines in quoted values may be affected by execution behaviour such as parallel file scanning. Setting this to true ensures that newlines in values are parsed successfully, which may reduce performance.

The default behaviour depends on the datafusion.catalog.newlines_in_values setting.

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>

comment: Option<u8>

Implementations

impl CsvOptions

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

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

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

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

• default to true

pub fn has_header(&self) -> Option<bool>

Returns true if the first line is a header. If format options does not specify whether there is a header, returns None (indicating that the configuration should be consulted).

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

The character separating values within a row.

• default to ‘,’

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

The quote character in a row.

• default to ‘“’

pub fn with_terminator(self, terminator: Option<u8>) -> CsvOptions

The character that terminates a row.

• default to None (CRLF)

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

The escape character in a row.

• default is None

pub fn with_double_quote(self, double_quote: bool) -> CsvOptions

Set true to indicate that the CSV quotes should be doubled.

• default to true

pub fn with_newlines_in_values(self, newlines_in_values: bool) -> CsvOptions

Specifies whether newlines in (quoted) values are supported.

Parsing newlines in quoted values may be affected by execution behaviour such as parallel file scanning. Setting this to true ensures that newlines in values are parsed successfully, which may reduce performance.

The default behaviour depends on the datafusion.catalog.newlines_in_values setting.

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

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 terminator(&self) -> Option<u8>

The terminator 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<(), DataFusionError>

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

where V: Visit,

impl Debug for CsvOptions

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

Formats the value using the given formatter.

impl Default for CsvOptions

fn default() -> CsvOptions

Returns the “default value” for a type.

impl PartialEq for CsvOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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<CsvWriterOptions, DataFusionError>

Performs the conversion.

impl StructuralPartialEq for CsvOptions