All Products
Search
Document Center

Tablestore:AddDefinedColumn

Last Updated:Apr 09, 2024

Adds predefined columns to a data table. Predefined columns can be used as the primary key columns or attribute columns of an index table that is created for the data table.

Usage notes

  • You must add predefined columns to a data table only when you want to use a secondary index that is created for the data table. You do not need to add predefined columns to a data table when you want to use a search index that is created for the data table.

  • You can add up to 32 predefined columns to a data table.

Request syntax

message AddDefinedColumnRequest {
    required string table_name = 1;
    repeated DefinedColumnSchema columns = 2;
}

Parameter

Type

Required

Description

table_name

string

Yes

The name of the data table.

columns

DefinedColumnSchema

Yes

The schema of predefined columns.

Response syntax

message AddDefinedColumnResponse {
}

Use Tablestore SDKs

You can use the following Tablestore SDKs to add predefined columns to a data table: