Package software.amazon.awscdk.services.glue.alpha

Enum StorageParameters

java.lang.Object
java.lang.Enum<StorageParameters>
software.amazon.awscdk.services.glue.alpha.StorageParameters
All Implemented Interfaces:
Serializable, Comparable<StorageParameters>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:11.595Z") @Stability(Experimental) public enum StorageParameters extends Enum<StorageParameters>
(experimental) The storage parameter keys that are currently known, this list is not exhaustive and other keys may be used.

Example: 

 IDatabase glueDatabase;
 Table table = Table.Builder.create(this, "Table")
         .storageParameters(List.of(StorageParameter.skipHeaderLineCount(1), StorageParameter.compressionType(CompressionType.GZIP), StorageParameter.custom("foo", "bar"), StorageParameter.custom("separatorChar", ","), StorageParameter.custom(StorageParameters.WRITE_PARALLEL, "off")))
         // ...
         .database(glueDatabase)
         .columns(List.of(Column.builder()
                 .name("col1")
                 .type(Schema.STRING)
                 .build()))
         .dataFormat(DataFormat.CSV)
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    COLUMN_COUNT_MISMATCH_HANDLING
    (experimental) Identifies if the file contains less or more values for a row than the number of columns specified in the external table definition.
    COMPRESSION_TYPE
    (experimental) The type of compression used on the table, when the file name does not contain an extension.
    DATA_CLEANSING_ENABLED
    (experimental) Determines whether data handling is on for the table.
    INVALID_CHAR_HANDLING
    (experimental) Specifies the action to perform when query results contain invalid UTF-8 character values.
    NUM_ROWS
    (experimental) A property that sets the numRows value for the table definition.
    NUMERIC_OVERFLOW_HANDLING
    (experimental) Specifies the action to perform when ORC data contains an integer (for example, BIGINT or int64) that is larger than the column definition (for example, SMALLINT or int16).
    ORC_SCHEMA_RESOLUTION
    (experimental) A property that sets the column mapping type for tables that use ORC data format.
    REPLACEMENT_CHAR
    (experimental) Specifies the replacement character to use when you set INVALID_CHAR_HANDLING to REPLACE.
    SERIALIZATION_NULL_FORMAT
    (experimental) A property that sets number of rows to skip at the beginning of each source file.
    SKIP_HEADER_LINE_COUNT
    (experimental) The number of rows to skip at the top of a CSV file when the table is being created.
    SURPLUS_BYTES_HANDLING
    (experimental) Specifies how to handle data being loaded that exceeds the length of the data type defined for columns containing VARBYTE data.
    SURPLUS_CHAR_HANDLING
    (experimental) Specifies how to handle data being loaded that exceeds the length of the data type defined for columns containing VARCHAR, CHAR, or string data.
    WRITE_KMS_KEY_ID
    (experimental) You can specify an AWS Key Management Service key to enable Server–Side Encryption (SSE) for Amazon S3 objects.
    WRITE_MAX_FILESIZE_MB
    (experimental) A property that sets the maximum size (in MB) of each file written to Amazon S3 by CREATE EXTERNAL TABLE AS.
    WRITE_PARALLEL
    (experimental) A property that sets whether CREATE EXTERNAL TABLE AS should write data in parallel.

  • Method Summary

    Modifier and Type
    Method
    Description
    static StorageParameters
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static StorageParameters[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SKIP_HEADER_LINE_COUNT

      @Stability(Experimental) public static final StorageParameters SKIP_HEADER_LINE_COUNT
      (experimental) The number of rows to skip at the top of a CSV file when the table is being created.

    • DATA_CLEANSING_ENABLED

      @Stability(Experimental) public static final StorageParameters DATA_CLEANSING_ENABLED
      (experimental) Determines whether data handling is on for the table.

    • COMPRESSION_TYPE

      @Stability(Experimental) public static final StorageParameters COMPRESSION_TYPE
      (experimental) The type of compression used on the table, when the file name does not contain an extension.

      This value overrides the compression type specified through the extension.

    • INVALID_CHAR_HANDLING

      @Stability(Experimental) public static final StorageParameters INVALID_CHAR_HANDLING
      (experimental) Specifies the action to perform when query results contain invalid UTF-8 character values.

    • REPLACEMENT_CHAR

      @Stability(Experimental) public static final StorageParameters REPLACEMENT_CHAR
      (experimental) Specifies the replacement character to use when you set INVALID_CHAR_HANDLING to REPLACE.

    • NUMERIC_OVERFLOW_HANDLING

      @Stability(Experimental) public static final StorageParameters NUMERIC_OVERFLOW_HANDLING
      (experimental) Specifies the action to perform when ORC data contains an integer (for example, BIGINT or int64) that is larger than the column definition (for example, SMALLINT or int16).

    • SURPLUS_BYTES_HANDLING

      @Stability(Experimental) public static final StorageParameters SURPLUS_BYTES_HANDLING
      (experimental) Specifies how to handle data being loaded that exceeds the length of the data type defined for columns containing VARBYTE data.

      By default, Redshift Spectrum sets the value to null for data that exceeds the width of the column.

    • SURPLUS_CHAR_HANDLING

      @Stability(Experimental) public static final StorageParameters SURPLUS_CHAR_HANDLING
      (experimental) Specifies how to handle data being loaded that exceeds the length of the data type defined for columns containing VARCHAR, CHAR, or string data.

      By default, Redshift Spectrum sets the value to null for data that exceeds the width of the column.

    • COLUMN_COUNT_MISMATCH_HANDLING

      @Stability(Experimental) public static final StorageParameters COLUMN_COUNT_MISMATCH_HANDLING
      (experimental) Identifies if the file contains less or more values for a row than the number of columns specified in the external table definition.

      This property is only available for an uncompressed text file format.

    • NUM_ROWS

      @Stability(Experimental) public static final StorageParameters NUM_ROWS
      (experimental) A property that sets the numRows value for the table definition.

      To explicitly update an external table's statistics, set the numRows property to indicate the size of the table. Amazon Redshift doesn't analyze external tables to generate the table statistics that the query optimizer uses to generate a query plan. If table statistics aren't set for an external table, Amazon Redshift generates a query execution plan based on an assumption that external tables are the larger tables and local tables are the smaller tables.

    • SERIALIZATION_NULL_FORMAT

      @Stability(Experimental) public static final StorageParameters SERIALIZATION_NULL_FORMAT
      (experimental) A property that sets number of rows to skip at the beginning of each source file.

    • ORC_SCHEMA_RESOLUTION

      @Stability(Experimental) public static final StorageParameters ORC_SCHEMA_RESOLUTION
      (experimental) A property that sets the column mapping type for tables that use ORC data format.

      This property is ignored for other data formats.

    • WRITE_PARALLEL

      @Stability(Experimental) public static final StorageParameters WRITE_PARALLEL
      (experimental) A property that sets whether CREATE EXTERNAL TABLE AS should write data in parallel.

      When 'write.parallel' is set to off, CREATE EXTERNAL TABLE AS writes to one or more data files serially onto Amazon S3. This table property also applies to any subsequent INSERT statement into the same external table.

    • WRITE_MAX_FILESIZE_MB

      @Stability(Experimental) public static final StorageParameters WRITE_MAX_FILESIZE_MB
      (experimental) A property that sets the maximum size (in MB) of each file written to Amazon S3 by CREATE EXTERNAL TABLE AS.

      The size must be a valid integer between 5 and 6200. The default maximum file size is 6,200 MB. This table property also applies to any subsequent INSERT statement into the same external table.

    • WRITE_KMS_KEY_ID

      @Stability(Experimental) public static final StorageParameters WRITE_KMS_KEY_ID
      (experimental) You can specify an AWS Key Management Service key to enable Server–Side Encryption (SSE) for Amazon S3 objects.

  • Method Details

    • values

      public static StorageParameters[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static StorageParameters valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null