列出多元索引

更新时间:
复制 MD 格式

Java SDK 可列出指定数据表的所有多元索引,并返回每个索引所属的数据表名称和索引名称。

前提条件

开始前,完成以下准备工作:

功能说明

调用 listSearchIndex 方法列出指定数据表的所有多元索引。请求中需要指定数据表名称。

public ListSearchIndexResponse listSearchIndex(ListSearchIndexRequest request)

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

String tableName = "example_table";
ListSearchIndexRequest request = new ListSearchIndexRequest();
request.setTableName(tableName);

ListSearchIndexResponse response = client.listSearchIndex(request);
for (SearchIndexInfo indexInfo : response.getIndexInfos()) {
    System.out.printf(
            "tableName=%s, indexName=%s%n",
            indexInfo.getTableName(),
            indexInfo.getIndexName());
}

参数说明

ListSearchIndexRequest 包含以下参数:

名称

类型

说明

tableName(必选)

String

数据表名称。

返回值

ListSearchIndexResponse 包含以下字段:

字段

类型

说明

indexInfos

List<SearchIndexInfo>

通过 getIndexInfos() 获取指定数据表的多元索引信息列表。

索引信息

indexInfos[] 中每个元素的类型为 SearchIndexInfo,包含以下字段:

字段

类型

说明

tableName

String

通过 getTableName() 获取数据表名称。

indexName

String

通过 getIndexName() 获取多元索引名称。