software.amazon.awscdk.services.glue

Interface TableProps

All Known Implementing Classes:

TableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:56.140Z")
public interface TableProps

Example:

 Database myDatabase;
 Table.Builder.create(this, "MyTable")
         .database(myDatabase)
         .tableName("my_table")
         .columns(List.of(Column.builder()
                 .name("col1")
                 .type(Schema.STRING)
                 .build()))
         .partitionKeys(List.of(Column.builder()
                 .name("year")
                 .type(Schema.SMALL_INT)
                 .build(), Column.builder()
                 .name("month")
                 .type(Schema.SMALL_INT)
                 .build()))
         .dataFormat(DataFormat.JSON)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TableProps.Builder A builder for TableProps
static class	TableProps.Jsii$Proxy An implementation for TableProps

Method Summary

Modifier and Type	Method and Description
static TableProps.Builder	builder()
default IBucket	getBucket() (experimental) S3 bucket in which to store data.
java.util.List<Column>	getColumns() (experimental) Columns of the table.
default java.lang.Boolean	getCompressed() (experimental) Indicates whether the table's data is compressed or not.
IDatabase	getDatabase() (experimental) Database in which to store the table.
DataFormat	getDataFormat() (experimental) Storage type of the table's data.
default java.lang.String	getDescription() (experimental) Description of the table.
default TableEncryption	getEncryption() (experimental) The kind of encryption to secure the data with.
default IKey	getEncryptionKey() (experimental) External KMS key to use for bucket encryption.
default java.util.List<PartitionIndex>	getPartitionIndexes() (experimental) Partition indexes on the table.
default java.util.List<Column>	getPartitionKeys() (experimental) Partition columns of the table.
default java.lang.String	getS3Prefix() (experimental) S3 prefix under which table objects are stored.
default java.lang.Boolean	getStoredAsSubDirectories() (experimental) Indicates whether the table data is stored in subdirectories.
java.lang.String	getTableName() (experimental) Name of the table.

Method Detail

getColumns

java.util.List<Column> getColumns()

(experimental) Columns of the table.

getDatabase

IDatabase getDatabase()

(experimental) Database in which to store the table.

getDataFormat

DataFormat getDataFormat()

(experimental) Storage type of the table's data.

getTableName

java.lang.String getTableName()

(experimental) Name of the table.

getBucket

default IBucket getBucket()

(experimental) S3 bucket in which to store data.

Default: one is created for you

getCompressed

default java.lang.Boolean getCompressed()

(experimental) Indicates whether the table's data is compressed or not.

Default: false

getDescription

default java.lang.String getDescription()

(experimental) Description of the table.

Default: generated

getEncryption

default TableEncryption getEncryption()

(experimental) The kind of encryption to secure the data with.

You can only provide this option if you are not explicitly passing in a bucket.

If you choose SSE-KMS, you can provide an un-managed KMS key with encryptionKey. If you choose CSE-KMS, you must provide an un-managed KMS key with encryptionKey.

Default: Unencrypted

getEncryptionKey

default IKey getEncryptionKey()

(experimental) External KMS key to use for bucket encryption.

The encryption property must be SSE-KMS or CSE-KMS.

Default: key is managed by KMS.

getPartitionIndexes

default java.util.List<PartitionIndex> getPartitionIndexes()

(experimental) Partition indexes on the table.

A maximum of 3 indexes are allowed on a table. Keys in the index must be part of the table's partition keys.

Default: table has no partition indexes

getPartitionKeys

default java.util.List<Column> getPartitionKeys()

(experimental) Partition columns of the table.

Default: table is not partitioned

getS3Prefix

default java.lang.String getS3Prefix()

(experimental) S3 prefix under which table objects are stored.

Default: - No prefix. The data will be stored under the root of the bucket.

getStoredAsSubDirectories

default java.lang.Boolean getStoredAsSubDirectories()

(experimental) Indicates whether the table data is stored in subdirectories.

Default: false

builder

static TableProps.Builder builder()

Returns:

a TableProps.Builder of TableProps