interface Column
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Redshift.Alpha.Column |
![]() | github.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#Column |
![]() | software.amazon.awscdk.services.redshift.alpha.Column |
![]() | aws_cdk.aws_redshift_alpha.Column |
![]() | @aws-cdk/aws-redshift-alpha ยป Column |
A column in a Redshift table.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';
const column: redshift_alpha.Column = {
dataType: 'dataType',
name: 'name',
// the properties below are optional
comment: 'comment',
distKey: false,
encoding: redshift_alpha.ColumnEncoding.AUTO,
id: 'id',
sortKey: false,
};
Properties
Name | Type | Description |
---|---|---|
data | string | The data type of the column. |
name | string | The name of the column. |
comment? | string | A comment to attach to the column. |
dist | boolean | Boolean value that indicates whether the column is to be configured as DISTKEY. |
encoding? | Column | The encoding to use for the column. |
id? | string | The unique identifier of the column. |
sort | boolean | Boolean value that indicates whether the column is to be configured as SORTKEY. |
dataType
Type:
string
The data type of the column.
name
Type:
string
The name of the column.
This will appear on Amazon Redshift.
comment?
Type:
string
(optional, default: no comment)
A comment to attach to the column.
distKey?
Type:
boolean
(optional, default: column is not DISTKEY)
Boolean value that indicates whether the column is to be configured as DISTKEY.
encoding?
Type:
Column
(optional, default: Amazon Redshift determines the encoding based on the data type.)
The encoding to use for the column.
id?
Type:
string
(optional, default: the column name is used as the identifier)
The unique identifier of the column.
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.
sortKey?
Type:
boolean
(optional, default: column is not a SORTKEY)
Boolean value that indicates whether the column is to be configured as SORTKEY.