All Products
Search
Document Center

Tablestore:CreateIndex

Last Updated:Apr 29, 2026

Call the CreateIndex API to create an index table on a specified data table.

Request message structure

message CreateIndexRequest {
    required string main_table_name = 1;
    required IndexMeta index_meta = 2;
    optional bool include_base_data = 3;
}

Parameter

Type

Required

Description

main_table_name

string

Yes

The name of the data table to which the index table belongs.

index_meta

IndexMeta

Yes

The schema of the index table.

include_base_data

bool

No

Specifies whether to index the historical data in the data table.

Response message structure

message CreateIndexResponse {
}

Using the SDK

SDK examples are available for the following languages: