Class TableBaseProps

Inheritance
object
TableBaseProps
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Glue.Alpha
Assembly: Amazon.CDK.AWS.Glue.Alpha.dll
Syntax (csharp)
public class TableBaseProps : ITableBaseProps
Syntax (vb)
Public Class TableBaseProps Implements ITableBaseProps
Remarks

Stability: Deprecated

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue.Alpha;

             Database database;
             DataFormat dataFormat;
             PartitionProjectionConfiguration partitionProjectionConfiguration;
             StorageParameter storageParameter;
             Type type;

             var tableBaseProps = new TableBaseProps {
                 Columns = new [] { new Column {
                     Name = "name",
                     Type = type,

                     // the properties below are optional
                     Comment = "comment"
                 } },
                 Database = database,
                 DataFormat = dataFormat,

                 // the properties below are optional
                 Compressed = false,
                 Description = "description",
                 EnablePartitionFiltering = false,
                 HasEncryptedData = false,
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 PartitionIndexes = new [] { new PartitionIndex {
                     KeyNames = new [] { "keyNames" },

                     // the properties below are optional
                     IndexName = "indexName"
                 } },
                 PartitionKeys = new [] { new Column {
                     Name = "name",
                     Type = type,

                     // the properties below are optional
                     Comment = "comment"
                 } },
                 PartitionProjection = new Dictionary<string, PartitionProjectionConfiguration> {
                     { "partitionProjectionKey", partitionProjectionConfiguration }
                 },
                 StorageParameters = new [] { storageParameter },
                 StoredAsSubDirectories = false,
                 TableName = "tableName"
             };

Synopsis

Constructors

TableBaseProps()

Properties

Columns

(deprecated) Columns of the table.
Compressed

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

(deprecated) Storage type of the table's data.
Database

(deprecated) Database in which to store the table.
Description

(deprecated) Description of the table.
EnablePartitionFiltering

(deprecated) Enables partition filtering.
HasEncryptedData

(deprecated) Whether the data stored in the table is encrypted.
Parameters

(deprecated) The key/value pairs define properties associated with the table.
PartitionIndexes

(deprecated) Partition indexes on the table.
PartitionKeys

(deprecated) Partition columns of the table.
PartitionProjection

(deprecated) Partition projection configuration for this table.
StorageParameters

(deprecated) The user-supplied properties for the description of the physical storage of this table.
StoredAsSubDirectories

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

(deprecated) Name of the table.

Constructors

TableBaseProps()

public TableBaseProps()
Remarks

Stability: Deprecated

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue.Alpha;

             Database database;
             DataFormat dataFormat;
             PartitionProjectionConfiguration partitionProjectionConfiguration;
             StorageParameter storageParameter;
             Type type;

             var tableBaseProps = new TableBaseProps {
                 Columns = new [] { new Column {
                     Name = "name",
                     Type = type,

                     // the properties below are optional
                     Comment = "comment"
                 } },
                 Database = database,
                 DataFormat = dataFormat,

                 // the properties below are optional
                 Compressed = false,
                 Description = "description",
                 EnablePartitionFiltering = false,
                 HasEncryptedData = false,
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 PartitionIndexes = new [] { new PartitionIndex {
                     KeyNames = new [] { "keyNames" },

                     // the properties below are optional
                     IndexName = "indexName"
                 } },
                 PartitionKeys = new [] { new Column {
                     Name = "name",
                     Type = type,

                     // the properties below are optional
                     Comment = "comment"
                 } },
                 PartitionProjection = new Dictionary<string, PartitionProjectionConfiguration> {
                     { "partitionProjectionKey", partitionProjectionConfiguration }
                 },
                 StorageParameters = new [] { storageParameter },
                 StoredAsSubDirectories = false,
                 TableName = "tableName"
             };

Properties

Columns

(deprecated) Columns of the table.

[Obsolete]
public IColumn[] Columns { get; set; }
Property Value

IColumn[]

Remarks

Stability: Deprecated

Compressed

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

[Obsolete]
public bool? Compressed { get; set; }
Property Value

bool?

Remarks

Default: false

Stability: Deprecated

DataFormat

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

[Obsolete]
public DataFormat DataFormat { get; set; }
Property Value

DataFormat

Remarks

Stability: Deprecated

Database

(deprecated) Database in which to store the table.

[Obsolete]
public IDatabase Database { get; set; }
Property Value

IDatabase

Remarks

Stability: Deprecated

Description

(deprecated) Description of the table.

[Obsolete]
public string? Description { get; set; }
Property Value

string

Remarks

Default: generated

Stability: Deprecated

EnablePartitionFiltering

(deprecated) Enables partition filtering.

[Obsolete]
public bool? EnablePartitionFiltering { get; set; }
Property Value

bool?

Remarks

Default: - The parameter is not defined

Stability: Deprecated

See: https://docs.aws.amazon.com/athena/latest/ug/glue-best-practices.html#glue-best-practices-partition-index

HasEncryptedData

(deprecated) Whether the data stored in the table is encrypted.

[Obsolete]
public bool? HasEncryptedData { get; set; }
Property Value

bool?

Remarks

This sets the has_encrypted_data table parameter. Athena reads it when querying client-side (CSE-KMS) encrypted datasets; for server-side encrypted (SSE-S3 / SSE-KMS) or unencrypted data it has no effect, since Amazon S3 decrypts server-side encrypted objects transparently.

Do not also set has_encrypted_data through parameters - use this property instead. A conflicting value in parameters is rejected.

Default: true

Stability: Deprecated

See: https://docs.aws.amazon.com/athena/latest/ug/creating-tables-based-on-encrypted-datasets-in-s3.html

Parameters

(deprecated) The key/value pairs define properties associated with the table.

[Obsolete]
public IDictionary<string, string>? Parameters { get; set; }
Property Value

IDictionary<string, string>

Remarks

The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

Default: - The parameter is not defined

Stability: Deprecated

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters

PartitionIndexes

(deprecated) Partition indexes on the table.

[Obsolete]
public IPartitionIndex[]? PartitionIndexes { get; set; }
Property Value

IPartitionIndex[]

Remarks

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

Stability: Deprecated

PartitionKeys

(deprecated) Partition columns of the table.

[Obsolete]
public IColumn[]? PartitionKeys { get; set; }
Property Value

IColumn[]

Remarks

Default: table is not partitioned

Stability: Deprecated

PartitionProjection

(deprecated) Partition projection configuration for this table.

[Obsolete]
public IDictionary<string, PartitionProjectionConfiguration>? PartitionProjection { get; set; }
Property Value

IDictionary<string, PartitionProjectionConfiguration>

Remarks

Partition projection allows Athena to automatically add new partitions without requiring ALTER TABLE ADD PARTITION statements.

Default: - No partition projection

Stability: Deprecated

See: https://docs.aws.amazon.com/athena/latest/ug/partition-projection.html

StorageParameters

(deprecated) The user-supplied properties for the description of the physical storage of this table.

[Obsolete]
public StorageParameter[]? StorageParameters { get; set; }
Property Value

StorageParameter[]

Remarks

These properties help describe the format of the data that is stored within the crawled data sources.

The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

Some keys will be auto-populated by glue crawlers, however, you can override them by specifying the key and value in this property.

Default: - The parameter is not defined

Stability: Deprecated

See: https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_EXTERNAL_TABLE.html#r_CREATE_EXTERNAL_TABLE-parameters - under "TABLE PROPERTIES"

Examples
IDatabase glueDatabase;

             var table = new S3Table(this, "Table", new S3TableProps {
                 StorageParameters = new [] { StorageParameter.SkipHeaderLineCount(1), StorageParameter.CompressionType(CompressionType.GZIP), StorageParameter.Custom("foo", "bar"), StorageParameter.Custom("separatorChar", ","), StorageParameter.Custom(StorageParameters.WRITE_PARALLEL, "off") },
                 // ...
                 Database = glueDatabase,
                 Columns = new [] { new Column {
                     Name = "col1",
                     Type = Schema.STRING
                 } },
                 DataFormat = DataFormat.CSV
             });

StoredAsSubDirectories

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

[Obsolete]
public bool? StoredAsSubDirectories { get; set; }
Property Value

bool?

Remarks

Default: false

Stability: Deprecated

TableName

(deprecated) Name of the table.

[Obsolete]
public string? TableName { get; set; }
Property Value

string

Remarks

Default: - generated by CDK.

Stability: Deprecated

Implements