列出多元索引

更新时间:
复制 MD 格式

使用 Python SDK 列出指定数据表或当前实例的多元索引。

前提条件

安装Tablestore Python SDK并初始化客户端。

功能说明

调用 list_search_index 方法列出多元索引。指定数据表名称时返回该数据表的所有多元索引;不指定时返回当前实例的所有多元索引。

def list_search_index(self, table_name=None)

以下示例列出 example_table 的所有多元索引,并输出每个索引所属的数据表名称和索引名称。

search_indexes = client.list_search_index("example_table")
for table_name, index_name in search_indexes:
    print(table_name, index_name)

参数说明

list_search_index 方法包含以下参数。

名称

类型

说明

table_name(可选)

str

数据表名称。指定时返回该数据表的所有多元索引;不指定时返回当前实例的所有多元索引。

返回值

list_search_index 方法返回 List[Tuple[str, str]]。列表中的每个元组依次包含数据表名称和多元索引名称。

场景示例

列出实例的所有多元索引

以下示例不指定数据表名称,列出当前实例的所有多元索引。

search_indexes = client.list_search_index()
for table_name, index_name in search_indexes:
    print(table_name, index_name)