Skip to content

TableProps

Properties for defining a Table.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ots-table

Initializer 

import { TableProps } from '@alicloud/ros-cdk-ots'
const tableProps: TableProps = { ... }

Properties

Name Type Description
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: The name of the OTS instance in which table will locate.
primaryKey @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PrimaryKeyProperty[] Property primaryKey: It describes the attribute value of primary key.
tableName string | @alicloud/ros-cdk-core.IResolvable Property tableName: The table name of the OTS instance.
columns @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ColumnsProperty[] Property columns: Attribute column for table store.
deviationCellVersionInSec number | @alicloud/ros-cdk-core.IResolvable Property deviationCellVersionInSec: Maximum version deviation.
maxVersions number | @alicloud/ros-cdk-core.IResolvable Property maxVersions: The maximum number of versions stored in this table.
reservedThroughput @alicloud/ros-cdk-core.IResolvable | ReservedThroughputProperty Property reservedThroughput: The initial reserved read\/write throughput setting of the table to be created, the reserved read throughput and reserved write throughput of any table cannot exceed 5000.
secondaryIndices @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SecondaryIndicesProperty[] Property secondaryIndices: The secondary indices of the table.
timeToLive number | @alicloud/ros-cdk-core.IResolvable Property timeToLive: The retention time of data stored in this table (unit: second).

instanceNameRequired 

public readonly instanceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceName: The name of the OTS instance in which table will locate.

primaryKeyRequired 

public readonly primaryKey: IResolvable | IResolvable | PrimaryKeyProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PrimaryKeyProperty[]

Property primaryKey: It describes the attribute value of primary key.

The number of primary_key should not be less than one and not be more than four.

tableNameRequired 

public readonly tableName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property tableName: The table name of the OTS instance.

columnsOptional 

public readonly columns: IResolvable | IResolvable | ColumnsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ColumnsProperty[]

Property columns: Attribute column for table store.

deviationCellVersionInSecOptional 

public readonly deviationCellVersionInSec: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property deviationCellVersionInSec: Maximum version deviation.

The purpose is mainly to prohibit writing and expected large data, such as setting the deviation_cell_version_in_sec to 1000, and if the current timestamp is 10000, the timestamp range allowed to be written is [10000 - 1000, 10000 + 1000]. The valid value is 1-9223372036854775807. Defaults to 86400.

maxVersionsOptional 

public readonly maxVersions: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property maxVersions: The maximum number of versions stored in this table.

The valid value is 1-2147483647. Default to 1.

reservedThroughputOptional 

public readonly reservedThroughput: IResolvable | ReservedThroughputProperty;

Property reservedThroughput: The initial reserved read\/write throughput setting of the table to be created, the reserved read throughput and reserved write throughput of any table cannot exceed 5000.

secondaryIndicesOptional 

public readonly secondaryIndices: IResolvable | IResolvable | SecondaryIndicesProperty[];

Property secondaryIndices: The secondary indices of the table.

timeToLiveOptional 

public readonly timeToLive: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property timeToLive: The retention time of data stored in this table (unit: second).

The value maximum is 2147483647 and -1 means never expired. Default to -1.