Skip to content

/AWS1/CL_S3_CSVINPUT

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_fileheaderinfo TYPE /AWS1/S3_FILEHEADERINFO /AWS1/S3_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).

iv_comments TYPE /AWS1/S3_COMMENTS /AWS1/S3_COMMENTS

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: #

iv_quoteescapecharacter TYPE /AWS1/S3_QUOTEESCAPECHARACTER /AWS1/S3_QUOTEESCAPECHARACTER

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 ".

iv_recorddelimiter TYPE /AWS1/S3_RECORDDELIMITER /AWS1/S3_RECORDDELIMITER

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

iv_fielddelimiter TYPE /AWS1/S3_FIELDDELIMITER /AWS1/S3_FIELDDELIMITER

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

iv_quotecharacter TYPE /AWS1/S3_QUOTECHARACTER /AWS1/S3_QUOTECHARACTER

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

iv_allowquotrecorddelimiter TYPE /AWS1/S3_ALLOWQUOTRECDELIMITER /AWS1/S3_ALLOWQUOTRECDELIMITER

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.


Queryable Attributes

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

Accessible with the following methods

Method Description
GET_FILEHEADERINFO() Getter for FILEHEADERINFO, with configurable default
ASK_FILEHEADERINFO() Getter for FILEHEADERINFO w/ exceptions if field has no valu
HAS_FILEHEADERINFO() Determine if FILEHEADERINFO has a value

Comments

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: #

Accessible with the following methods

Method Description
GET_COMMENTS() Getter for COMMENTS, with configurable default
ASK_COMMENTS() Getter for COMMENTS w/ exceptions if field has no value
HAS_COMMENTS() Determine if COMMENTS has a value

QuoteEscapeCharacter

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 ".

Accessible with the following methods

Method Description
GET_QUOTEESCAPECHARACTER() Getter for QUOTEESCAPECHARACTER, with configurable default
ASK_QUOTEESCAPECHARACTER() Getter for QUOTEESCAPECHARACTER w/ exceptions if field has n
HAS_QUOTEESCAPECHARACTER() Determine if QUOTEESCAPECHARACTER has a value

RecordDelimiter

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

Accessible with the following methods

Method Description
GET_RECORDDELIMITER() Getter for RECORDDELIMITER, with configurable default
ASK_RECORDDELIMITER() Getter for RECORDDELIMITER w/ exceptions if field has no val
HAS_RECORDDELIMITER() Determine if RECORDDELIMITER has a value

FieldDelimiter

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

Accessible with the following methods

Method Description
GET_FIELDDELIMITER() Getter for FIELDDELIMITER, with configurable default
ASK_FIELDDELIMITER() Getter for FIELDDELIMITER w/ exceptions if field has no valu
HAS_FIELDDELIMITER() Determine if FIELDDELIMITER has a value

QuoteCharacter

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

Accessible with the following methods

Method Description
GET_QUOTECHARACTER() Getter for QUOTECHARACTER, with configurable default
ASK_QUOTECHARACTER() Getter for QUOTECHARACTER w/ exceptions if field has no valu
HAS_QUOTECHARACTER() Determine if QUOTECHARACTER has a value

AllowQuotedRecordDelimiter

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.

Accessible with the following methods

Method Description
GET_ALLOWQUOTRECORDDELIMITER() Getter for ALLOWQUOTEDRECORDDELIMITER, with configurable def
ASK_ALLOWQUOTRECORDDELIMITER() Getter for ALLOWQUOTEDRECORDDELIMITER w/ exceptions if field
HAS_ALLOWQUOTRECORDDELIMITER() Determine if ALLOWQUOTEDRECORDDELIMITER has a value