Interface IColumn

(experimental) A column in a Redshift table.

Namespace: Amazon.CDK.AWS.Redshift.Alpha

Assembly: Amazon.CDK.AWS.Redshift.Alpha.dll

Syntax (csharp)

public interface IColumn

Syntax (vb)

Public Interface IColumn

Remarks

Stability: Experimental

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.Redshift.Alpha;

var column = new Column {
    DataType = "dataType",
    Name = "name",

    // the properties below are optional
    Comment = "comment",
    DistKey = false,
    Encoding = ColumnEncoding.AUTO,
    Id = "id",
    SortKey = false
};

Synopsis

Properties

Comment	(experimental) A comment to attach to the column.
DataType	(experimental) The data type of the column.
DistKey	(experimental) Boolean value that indicates whether the column is to be configured as DISTKEY.
Encoding	(experimental) The encoding to use for the column.
Id	(experimental) The unique identifier of the column.
Name	(experimental) The name of the column.
SortKey	(experimental) Boolean value that indicates whether the column is to be configured as SORTKEY.

Properties

Comment

(experimental) A comment to attach to the column.

virtual string Comment { get; }

Property Value

System.String

Remarks

Default: - no comment

Stability: Experimental

DataType

(experimental) The data type of the column.

string DataType { get; }

Property Value

System.String

Remarks

Stability: Experimental

DistKey

(experimental) Boolean value that indicates whether the column is to be configured as DISTKEY.

virtual Nullable<bool> DistKey { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - column is not DISTKEY

Stability: Experimental

Encoding

(experimental) The encoding to use for the column.

virtual Nullable<ColumnEncoding> Encoding { get; }

Property Value

System.Nullable<ColumnEncoding>

Remarks

Default: - Amazon Redshift determines the encoding based on the data type.

Stability: Experimental

Id

(experimental) The unique identifier of the column.

virtual string Id { get; }

Property Value

System.String

Remarks

This is not the name of the column, and renaming this identifier will cause a new column to be created and the old column to be dropped.

NOTE - This field will be set, however, only by setting the @aws-cdk/aws-redshift:columnId feature flag will this field be used.

Default: - the column name is used as the identifier

Stability: Experimental

Name

(experimental) The name of the column.

string Name { get; }

Property Value

System.String

Remarks

This will appear on Amazon Redshift.

Stability: Experimental

SortKey

(experimental) Boolean value that indicates whether the column is to be configured as SORTKEY.

virtual Nullable<bool> SortKey { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - column is not a SORTKEY

Stability: Experimental