Struct CsvInput

#[non_exhaustive]
pub struct CsvInput {
    pub file_header_info: Option<FileHeaderInfo>,
    pub comments: Option<String>,
    pub quote_escape_character: Option<String>,
    pub record_delimiter: Option<String>,
    pub field_delimiter: Option<String>,
    pub quote_character: Option<String>,
    pub allow_quoted_record_delimiter: Option<bool>,
}

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

file_header_info: Option<FileHeaderInfo>

Describes the first line of input. Valid values are:

• NONE: First line is not a header.

• IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).

• Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

comments: Option<String>

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

Default: #

quote_escape_character: Option<String>

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

record_delimiter: Option<String>

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

field_delimiter: Option<String>

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

quote_character: Option<String>

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

allow_quoted_record_delimiter: Option<bool>

Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

Implementations

impl CsvInput

pub fn file_header_info(&self) -> Option<&FileHeaderInfo>

Describes the first line of input. Valid values are:

• NONE: First line is not a header.

• IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).

• Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

pub fn comments(&self) -> Option<&str>

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

Default: #

pub fn quote_escape_character(&self) -> Option<&str>

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

pub fn record_delimiter(&self) -> Option<&str>

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

pub fn field_delimiter(&self) -> Option<&str>

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

pub fn quote_character(&self) -> Option<&str>

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

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

Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

impl CsvInput

pub fn builder() -> CsvInputBuilder

Creates a new builder-style object to manufacture CsvInput.

Trait Implementations

impl Clone for CsvInput

fn clone(&self) -> CsvInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsvInput

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

Formats the value using the given formatter.

impl PartialEq for CsvInput

fn eq(&self, other: &CsvInput) -> 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 StructuralPartialEq for CsvInput