二级索引相当于把数据表的主键查询能力扩展到了不同的列，当需要使用属性查询数据时，您可以通过创建二级索引加快数据查询的效率。设置预定义列后，在创建二级索引时将预定义列作为索引表的索引列或者属性列。创建二级索引后，您可以使用二级索引进行数据查询。
前提条件
已初始化Client。具体操作，请参见初始化OTSClient。
已创建数据表，且数据表的最大版本数（max_version）必须为1，数据生命周期（time_to_live）必须满足如下条件中的任意一个。具体操作，请参见创建数据表。
数据表的数据生命周期为-1（数据永不过期）。
数据表的数据生命周期不为-1时，数据表为禁止更新状态（即是否允许更新为否）。
数据表已设置预定义列。
注意事项
索引表名称不能与已存在的时序表名称和数据表名称相同。
创建二级索引时，系统会自动将未出现在索引列中的数据表主键补齐到索引表主键中。
创建本地二级索引时，索引表的第一列主键必须与数据表的第一列主键相同。
参数
参数 | 说明 |
main_table_name | 数据表名称。 |
index_meta | 索引表的结构信息，包括如下内容：
|
include_base_data | 索引表中是否包含数据表中已存在的数据。 当设置include_base_data为True时，表示包含存量数据；当设置include_base_data为False时，表示不包含存量数据。 |
示例
创建全局二级索引
以下示例用于在主键为pk1、pk2的数据表上创建主键列为definedcol1、pk1，属性列为definedcol2、definedcol3的索引表。
# 构造索引Meta。
# 依次设置索引表名称、索引表主键列和属性列。
index_meta = SecondaryIndexMeta('<INDEX_NAME>', ['definedcol1', 'pk1'], ['definedcol2', 'definedcol3'])
# 设置数据表名称，不包含存量数据。
client.create_secondary_index('<TABLE_NAME>', index_meta, False)
# 设置数据表名称，包含存量数据。
# 创建索引表后会开启数据表中存量数据的同步，然后可以通过索引表查询全部数据，同步时间和数据量的大小有一定的关系。
# client.create_secondary_index('<TABLE_NAME>', index_meta, True)
创建本地二级索引
以下示例用于在主键为pk1、pk2的数据表上创建主键列为pk1、definedcol1，属性列为definedcol2、definedcol3的索引表。
# 构造索引Meta。
# 依次设置索引表名称、索引表主键列、索引表属性列和索引类型。
# 本地二级索引的第一列主键必须和数据表的第一列主键相同。
index_meta = SecondaryIndexMeta('<INDEX_NAME>', ['pk1', 'definedcol1'], ['definedcol2', 'definedcol3'],index_type= SecondaryIndexType.LOCAL_INDEX)
# 设置数据表名称，不包含存量数据
client.create_secondary_index('<TABLE_NAME>', index_meta, False)
# 设置数据表名称，包含存量数据。
# 创建索引表后会开启数据表中存量数据的同步，然后可以通过索引表查询全部数据，同步时间和数据量的大小有一定的关系。
# client.create_secondary_index('<TABLE_NAME>', index_meta, True)
相关文档
创建二级索引后，您可以进行单行读取数据或范围读取数据操作。具体操作，请参见使用二级索引读取数据。
如果不再需要使用二级索引，您可以删除二级索引。具体操作，请参见删除二级索引。