Struct S3CsvSource

#[non_exhaustive]
pub struct S3CsvSource {

    pub name: String,
    pub paths: Vec<String>,
    pub compression_type: Option<CompressionType>,
    pub exclusions: Option<Vec<String>>,
    pub group_size: Option<String>,
    pub group_files: Option<String>,
    pub recurse: Option<bool>,
    pub max_band: Option<i32>,
    pub max_files_in_band: Option<i32>,
    pub additional_options: Option<S3DirectSourceAdditionalOptions>,
    pub separator: Separator,
    pub escaper: Option<String>,
    pub quote_char: QuoteChar,
    pub multiline: Option<bool>,
    pub with_header: Option<bool>,
    pub write_header: Option<bool>,
    pub skip_first: Option<bool>,
    pub optimize_performance: bool,
    pub output_schemas: Option<Vec<GlueSchema>>,
}

Specifies a command-separated value (CSV) data store stored in Amazon S3.

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.

name: String

The name of the data store.

paths: Vec<String>

A list of the Amazon S3 paths to read from.

compression_type: Option<CompressionType>

Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").

exclusions: Option<Vec<String>>

A string containing a JSON list of Unix-style glob patterns to exclude. For example, "\[\"**.pdf\"\]" excludes all PDF files.

group_size: Option<String>

The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

group_files: Option<String>

Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".

recurse: Option<bool>

If set to true, recursively reads files in all subdirectories under the specified paths.

max_band: Option<i32>

This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

max_files_in_band: Option<i32>

This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

additional_options: Option<S3DirectSourceAdditionalOptions>

Specifies additional connection options.

separator: Separator

Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.

escaper: Option<String>

Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n, \r, \t, and \0).

quote_char: QuoteChar

Specifies the character to use for quoting. The default is a double quote: '"'. Set this to -1 to turn off quoting entirely.

multiline: Option<bool>

A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.

with_header: Option<bool>

A Boolean value that specifies whether to treat the first line as a header. The default value is False.

write_header: Option<bool>

A Boolean value that specifies whether to write the header to output. The default value is True.

skip_first: Option<bool>

A Boolean value that specifies whether to skip the first data line. The default value is False.

optimize_performance: bool

A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.

output_schemas: Option<Vec<GlueSchema>>

Specifies the data schema for the S3 CSV source.

Implementations

impl S3CsvSource

pub fn name(&self) -> &str

The name of the data store.

pub fn paths(&self) -> &[String]

A list of the Amazon S3 paths to read from.

pub fn compression_type(&self) -> Option<&CompressionType>

Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip" and "bzip").

pub fn exclusions(&self) -> &[String]

A string containing a JSON list of Unix-style glob patterns to exclude. For example, "\[\"**.pdf\"\]" excludes all PDF files.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusions.is_none().

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

The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles" must be set to "inPartition" for this to take effect.

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

Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none".

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

If set to true, recursively reads files in all subdirectories under the specified paths.

pub fn max_band(&self) -> Option<i32>

This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.

pub fn max_files_in_band(&self) -> Option<i32>

This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.

pub fn additional_options(&self) -> Option<&S3DirectSourceAdditionalOptions>

Specifies additional connection options.

pub fn separator(&self) -> &Separator

Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.

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

Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n, \r, \t, and \0).

pub fn quote_char(&self) -> &QuoteChar

Specifies the character to use for quoting. The default is a double quote: '"'. Set this to -1 to turn off quoting entirely.

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

A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.

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

A Boolean value that specifies whether to treat the first line as a header. The default value is False.

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

A Boolean value that specifies whether to write the header to output. The default value is True.

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

A Boolean value that specifies whether to skip the first data line. The default value is False.

pub fn optimize_performance(&self) -> bool

A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.

pub fn output_schemas(&self) -> &[GlueSchema]

Specifies the data schema for the S3 CSV source.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .output_schemas.is_none().

impl S3CsvSource

pub fn builder() -> S3CsvSourceBuilder

Creates a new builder-style object to manufacture S3CsvSource.

Trait Implementations

impl Clone for S3CsvSource

fn clone(&self) -> S3CsvSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for S3CsvSource

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

Formats the value using the given formatter.

impl PartialEq for S3CsvSource

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

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

const 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 S3CsvSource