Schema of an index table - Tablestore - Alibaba Cloud Documentation Center

Specifies the schema of an index table.

Data structure

message IndexMeta {
    required string name = 1;
    repeated string primary_key = 2;
    repeated string defined_column = 3;
    required IndexUpdateMode index_update_mode = 4;
    required IndexType index_type = 5;
    optional IndexSyncPhase index_sync_phase = 6;
}

Parameter	Type	Required	Description
name	string	Yes	The name of the index table.
primary_key	string	Yes	The index columns of the index table. The index columns are a combination of primary key columns and predefined columns of the data table. If you use a local secondary index, the first primary key column of the index table must be the same as the first primary key column of the data table for which the index table is created.
defined_column	string	Yes	The attribute columns of the index table. The attribute columns are a combination of predefined columns of the data table.
index_update_mode	IndexUpdateMode	Yes	The update mode of the index table. Synchronous and asynchronous update modes are supported.
index_type	IndexType	Yes	The type of the index table. Global secondary index and local secondary index are supported.
index_sync_phase	IndexSyncPhase	No	The stage of index synchronization.