Struct datafusion::physical_plan::csv::CsvReadOptions

pub struct CsvReadOptions<'a> {
    pub has_header: bool,
    pub delimiter: u8,
    pub schema: Option<&'a Schema>,
    pub schema_infer_max_records: usize,
    pub file_extension: &'a str,
}

CSV file read option

Fields

has_header: bool

Does the CSV file have a header?

If schema inference is run on a file with no headers, default column names are created.

delimiter: u8

An optional column delimiter. Defaults to b','.

schema: Option<&'a Schema>

An optional schema representing the CSV files. If None, CSV reader will try to infer it based on data in file.

schema_infer_max_records: usize

Max number of rows to read from CSV files for schema inference if needed. Defaults to 1000.

file_extension: &'a str

File extension; only files with this extension are selected for data input. Defaults to ".csv".

Implementations

impl<'a> CsvReadOptions<'a>

pub fn new() -> Self

Create a CSV read option with default presets

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

Configure has_header setting

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

Specify delimiter to use for CSV read

pub fn file_extension(mut self: Self, file_extension: &'a str) -> Self

Specify the file extension for CSV file selection

pub fn delimiter_option(mut self: Self, delimiter: Option<u8>) -> Self

Configure delimiter setting with Option, None value will be ignored

pub fn schema(mut self: Self, schema: &'a Schema) -> Self

Specify schema to use for CSV read

pub fn schema_infer_max_records(mut self: Self, max_records: usize) -> Self

Configure number of max records to read for schema inference

Trait Implementations

impl<'a> Clone for CsvReadOptions<'a>

fn clone(&self) -> CsvReadOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CsvReadOptions<'a>