SelectConstants (Apache Hadoop Amazon Web Services support 3.3.0 API)

java.lang.Object
- org.apache.hadoop.fs.s3a.select.SelectConstants

```
@InterfaceAudience.Public
 @InterfaceStability.Unstable
public final class SelectConstants
extends Object
```
Options related to S3 Select. These options are set for the entire filesystem unless overridden as an option in the URI

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPRESSION_OPT_GZIP` Gzipped.
`static String`	`COMPRESSION_OPT_NONE` No compression.
`static String`	`CSV_HEADER_OPT_IGNORE` Ignore the header.
`static String`	`CSV_HEADER_OPT_NONE` No header: first row is data.
`static String`	`CSV_HEADER_OPT_USE` Use the header.
`static String`	`CSV_INPUT_COMMENT_MARKER` String which indicates the row is actually a comment.
`static String`	`CSV_INPUT_COMMENT_MARKER_DEFAULT` Default marker.
`static String`	`CSV_INPUT_FIELD_DELIMITER_DEFAULT` Default field delimiter.
`static String`	`CSV_INPUT_HEADER` How should headers be used? Value: "fs.s3a.select.input.csv.header".
`static String`	`CSV_INPUT_HEADER_OPT_DEFAULT` Default header mode: "ignore".
`static String`	`CSV_INPUT_INPUT_FIELD_DELIMITER` Field delimiter.
`static String`	`CSV_INPUT_QUOTE_CHARACTER` Quote Character.
`static String`	`CSV_INPUT_QUOTE_CHARACTER_DEFAULT` Default Quote Character.
`static String`	`CSV_INPUT_QUOTE_ESCAPE_CHARACTER` Character to escape quotes.
`static String`	`CSV_INPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT` Default quote escape character.
`static String`	`CSV_INPUT_RECORD_DELIMITER` Record delimiter.
`static String`	`CSV_INPUT_RECORD_DELIMITER_DEFAULT` Default delimiter Value: "\n".
`static String`	`CSV_OUTPUT_FIELD_DELIMITER` Field delimiter.
`static String`	`CSV_OUTPUT_FIELD_DELIMITER_DEFAULT` Default field delimiter.
`static String`	`CSV_OUTPUT_QUOTE_CHARACTER` Quote Character.
`static String`	`CSV_OUTPUT_QUOTE_CHARACTER_DEFAULT` Default Quote Character.
`static String`	`CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER` Character to escape quotes.
`static String`	`CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT` Default quote escape character.
`static String`	`CSV_OUTPUT_QUOTE_FIELDS` Should CSV fields be quoted? One of : ALWAYS, ASNEEDED Value: "fs.s3a.select.output.csv.quote.fields".
`static String`	`CSV_OUTPUT_QUOTE_FIELDS_ALWAYS` Output quotation policy (default): "always".
`static String`	`CSV_OUTPUT_QUOTE_FIELDS_AS_NEEEDED` Output quotation policy: "asneeded".
`static String`	`CSV_OUTPUT_RECORD_DELIMITER` Record delimiter.
`static String`	`CSV_OUTPUT_RECORD_DELIMITER_DEFAULT` Default delimiter Value: "\n".
`static String`	`FS_S3A_SELECT`
`static String`	`FS_S3A_SELECT_ENABLED` Flag: is S3 select enabled? Value: "fs.s3a.select.enabled".
`static String`	`FS_S3A_SELECT_INPUT_CSV` Prefix for all CSV input options.
`static String`	`FS_S3A_SELECT_OUTPUT_CSV` Prefix for all CSV output options.
`static String`	`S3_SELECT_CAPABILITY` Does the FS Support S3 Select? Value: "fs.s3a.capability.select.sql".
`static String`	`SELECT_ERRORS_INCLUDE_SQL` Should Select errors include the SQL statement? It is easier to debug but a security risk if the exceptions ever get printed/logged and the query contains secrets.
`static String`	`SELECT_FORMAT_CSV` CSV as an input or output format: "csv".
`static String`	`SELECT_FORMAT_JSON` JSON as an input or output format: "json".
`static String`	`SELECT_INPUT_COMPRESSION` How is the input compressed? This applies to all formats.
`static String`	`SELECT_INPUT_FORMAT` Input format for data.
`static String`	`SELECT_OUTPUT_FORMAT` Output format for data -that is, what the results are generated as.
`static String`	`SELECT_SQL` This is the big SQL expression: "fs.s3a.select.sql".
`static String`	`SELECT_UNSUPPORTED`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SELECT_UNSUPPORTED
```
public static final String SELECT_UNSUPPORTED
```
    See Also:
    
    Constant Field Values
  - FS_S3A_SELECT
```
public static final String FS_S3A_SELECT
```
    See Also:
    
    Constant Field Values
  - SELECT_SQL
```
public static final String SELECT_SQL
```
    This is the big SQL expression: "fs.s3a.select.sql". When used in an open() call, switch to a select operation. This is only used in the open call, never in a filesystem configuration.
    
    See Also:
    
    Constant Field Values
  - S3_SELECT_CAPABILITY
```
public static final String S3_SELECT_CAPABILITY
```
    Does the FS Support S3 Select? Value: "fs.s3a.capability.select.sql".
    
    See Also:
    
    Constant Field Values
  - FS_S3A_SELECT_ENABLED
```
public static final String FS_S3A_SELECT_ENABLED
```
    Flag: is S3 select enabled? Value: "fs.s3a.select.enabled".
    
    See Also:
    
    Constant Field Values
  - SELECT_INPUT_FORMAT
```
public static final String SELECT_INPUT_FORMAT
```
    Input format for data. Value: "fs.s3a.select.input.format".
    
    See Also:
    
    Constant Field Values
  - SELECT_OUTPUT_FORMAT
```
public static final String SELECT_OUTPUT_FORMAT
```
    Output format for data -that is, what the results are generated as. Value: "fs.s3a.select.output.format".
    
    See Also:
    
    Constant Field Values
  - SELECT_FORMAT_CSV
```
public static final String SELECT_FORMAT_CSV
```
    CSV as an input or output format: "csv".
    
    See Also:
    
    Constant Field Values
  - SELECT_FORMAT_JSON
```
public static final String SELECT_FORMAT_JSON
```
    JSON as an input or output format: "json".
    
    See Also:
    
    Constant Field Values
  - SELECT_ERRORS_INCLUDE_SQL
```
public static final String SELECT_ERRORS_INCLUDE_SQL
```
    Should Select errors include the SQL statement? It is easier to debug but a security risk if the exceptions ever get printed/logged and the query contains secrets.
    
    See Also:
    
    Constant Field Values
  - SELECT_INPUT_COMPRESSION
```
public static final String SELECT_INPUT_COMPRESSION
```
    How is the input compressed? This applies to all formats. Value: "fs.s3a.select.input.compression".
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_OPT_NONE
```
public static final String COMPRESSION_OPT_NONE
```
    No compression. Value: "none".
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_OPT_GZIP
```
public static final String COMPRESSION_OPT_GZIP
```
    Gzipped. Value: "gzip".
    
    See Also:
    
    Constant Field Values
  - FS_S3A_SELECT_INPUT_CSV
```
public static final String FS_S3A_SELECT_INPUT_CSV
```
    Prefix for all CSV input options. Value: "fs.s3a.select.input.csv.".
    
    See Also:
    
    Constant Field Values
  - FS_S3A_SELECT_OUTPUT_CSV
```
public static final String FS_S3A_SELECT_OUTPUT_CSV
```
    Prefix for all CSV output options. Value: "fs.s3a.select.output.csv.".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_COMMENT_MARKER
```
public static final String CSV_INPUT_COMMENT_MARKER
```
    String which indicates the row is actually a comment. Value: "fs.s3a.select.input.csv.comment.marker".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_COMMENT_MARKER_DEFAULT
```
public static final String CSV_INPUT_COMMENT_MARKER_DEFAULT
```
    Default marker. Value: "#".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_RECORD_DELIMITER
```
public static final String CSV_INPUT_RECORD_DELIMITER
```
    Record delimiter. CR, LF, etc. Value: "fs.s3a.select.input.csv.record.delimiter".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_RECORD_DELIMITER_DEFAULT
```
public static final String CSV_INPUT_RECORD_DELIMITER_DEFAULT
```
    Default delimiter Value: "\n".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_INPUT_FIELD_DELIMITER
```
public static final String CSV_INPUT_INPUT_FIELD_DELIMITER
```
    Field delimiter. Value: "fs.s3a.select.input.csv.field.delimiter".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_FIELD_DELIMITER_DEFAULT
```
public static final String CSV_INPUT_FIELD_DELIMITER_DEFAULT
```
    Default field delimiter. Value: ",".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_QUOTE_CHARACTER
```
public static final String CSV_INPUT_QUOTE_CHARACTER
```
    Quote Character. Value: "fs.s3a.select.input.csv.quote.character".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_QUOTE_CHARACTER_DEFAULT
```
public static final String CSV_INPUT_QUOTE_CHARACTER_DEFAULT
```
    Default Quote Character. Value: "\"".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_QUOTE_ESCAPE_CHARACTER
```
public static final String CSV_INPUT_QUOTE_ESCAPE_CHARACTER
```
    Character to escape quotes. If empty: no escaping. Value: "fs.s3a.select.input.csv.quote.escape.character".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT
```
public static final String CSV_INPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT
```
    Default quote escape character. Value: "\\".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_HEADER
```
public static final String CSV_INPUT_HEADER
```
    How should headers be used? Value: "fs.s3a.select.input.csv.header".
    
    See Also:
    
    Constant Field Values
  - CSV_HEADER_OPT_NONE
```
public static final String CSV_HEADER_OPT_NONE
```
    No header: first row is data. Value: "none".
    
    See Also:
    
    Constant Field Values
  - CSV_HEADER_OPT_IGNORE
```
public static final String CSV_HEADER_OPT_IGNORE
```
    Ignore the header. Value: "ignore".
    
    See Also:
    
    Constant Field Values
  - CSV_HEADER_OPT_USE
```
public static final String CSV_HEADER_OPT_USE
```
    Use the header. Value: "use".
    
    See Also:
    
    Constant Field Values
  - CSV_INPUT_HEADER_OPT_DEFAULT
```
public static final String CSV_INPUT_HEADER_OPT_DEFAULT
```
    Default header mode: "ignore".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_RECORD_DELIMITER
```
public static final String CSV_OUTPUT_RECORD_DELIMITER
```
    Record delimiter. CR, LF, etc. Value: "fs.s3a.select.output.csv.record.delimiter".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_RECORD_DELIMITER_DEFAULT
```
public static final String CSV_OUTPUT_RECORD_DELIMITER_DEFAULT
```
    Default delimiter Value: "\n".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_FIELD_DELIMITER
```
public static final String CSV_OUTPUT_FIELD_DELIMITER
```
    Field delimiter. Value: "fs.s3a.select.output.csv.field.delimiter".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_FIELD_DELIMITER_DEFAULT
```
public static final String CSV_OUTPUT_FIELD_DELIMITER_DEFAULT
```
    Default field delimiter. Value: ",".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_QUOTE_CHARACTER
```
public static final String CSV_OUTPUT_QUOTE_CHARACTER
```
    Quote Character. Value: "fs.s3a.select.output.csv.quote.character".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_QUOTE_CHARACTER_DEFAULT
```
public static final String CSV_OUTPUT_QUOTE_CHARACTER_DEFAULT
```
    Default Quote Character. Value: "\"".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_QUOTE_FIELDS
```
public static final String CSV_OUTPUT_QUOTE_FIELDS
```
    Should CSV fields be quoted? One of : ALWAYS, ASNEEDED Value: "fs.s3a.select.output.csv.quote.fields".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_QUOTE_FIELDS_ALWAYS
```
public static final String CSV_OUTPUT_QUOTE_FIELDS_ALWAYS
```
    Output quotation policy (default): "always".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_QUOTE_FIELDS_AS_NEEEDED
```
public static final String CSV_OUTPUT_QUOTE_FIELDS_AS_NEEEDED
```
    Output quotation policy: "asneeded".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER
```
public static final String CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER
```
    Character to escape quotes. If empty: no escaping. Value: "fs.s3a.select.output.csv.quote.escape.character".
    
    See Also:
    
    Constant Field Values
  - CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT
```
public static final String CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT
```
    Default quote escape character. Value: "".
    
    See Also:
    
    Constant Field Values

Class SelectConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SELECT_UNSUPPORTED

FS_S3A_SELECT

SELECT_SQL

S3_SELECT_CAPABILITY

FS_S3A_SELECT_ENABLED

SELECT_INPUT_FORMAT

SELECT_OUTPUT_FORMAT

SELECT_FORMAT_CSV

SELECT_FORMAT_JSON

SELECT_ERRORS_INCLUDE_SQL

SELECT_INPUT_COMPRESSION

COMPRESSION_OPT_NONE

COMPRESSION_OPT_GZIP

FS_S3A_SELECT_INPUT_CSV

FS_S3A_SELECT_OUTPUT_CSV

CSV_INPUT_COMMENT_MARKER

CSV_INPUT_COMMENT_MARKER_DEFAULT

CSV_INPUT_RECORD_DELIMITER

CSV_INPUT_RECORD_DELIMITER_DEFAULT

CSV_INPUT_INPUT_FIELD_DELIMITER

CSV_INPUT_FIELD_DELIMITER_DEFAULT

CSV_INPUT_QUOTE_CHARACTER

CSV_INPUT_QUOTE_CHARACTER_DEFAULT

CSV_INPUT_QUOTE_ESCAPE_CHARACTER

CSV_INPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT

CSV_INPUT_HEADER

CSV_HEADER_OPT_NONE

CSV_HEADER_OPT_IGNORE

CSV_HEADER_OPT_USE

CSV_INPUT_HEADER_OPT_DEFAULT

CSV_OUTPUT_RECORD_DELIMITER

CSV_OUTPUT_RECORD_DELIMITER_DEFAULT

CSV_OUTPUT_FIELD_DELIMITER

CSV_OUTPUT_FIELD_DELIMITER_DEFAULT

CSV_OUTPUT_QUOTE_CHARACTER

CSV_OUTPUT_QUOTE_CHARACTER_DEFAULT

CSV_OUTPUT_QUOTE_FIELDS

CSV_OUTPUT_QUOTE_FIELDS_ALWAYS

CSV_OUTPUT_QUOTE_FIELDS_AS_NEEEDED

CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER

CSV_OUTPUT_QUOTE_ESCAPE_CHARACTER_DEFAULT