Struct CsvExecBuilder

pub struct CsvExecBuilder { /* private fields */ }

👎Deprecated since 46.0.0: use FileScanConfig instead

Builder for CsvExec.

See example on CsvExec.

Implementations

impl CsvExecBuilder

pub fn new(file_scan_config: FileScanConfig) -> Self

Create a new builder to read the provided file scan configuration.

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

Set whether the first row defines the column names.

The default value is false.

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

Set the column delimeter.

The default is ,.

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

Set the quote character.

The default is ".

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

Set the line terminator. If not set, the default is CRLF.

The default is None.

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

Set the escape character.

The default is None (i.e. quotes cannot be escaped).

pub fn with_comment(self, comment: Option<u8>) -> Self

Set the comment character.

The default is None (i.e. comments are not supported).

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

Set 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 value is false.

pub fn with_file_compression_type( self, file_compression_type: FileCompressionType, ) -> Self

Set the file compression type.

The default is FileCompressionType::UNCOMPRESSED.

pub fn build(self) -> CsvExec

Build a CsvExec.

Trait Implementations

impl Clone for CsvExecBuilder

fn clone(&self) -> CsvExecBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsvExecBuilder

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

Formats the value using the given formatter.