文档

列出多元索引列表

更新时间:

创建多元索引后,您可以查询某个数据表关联的所有多元索引的列表信息。

接口

列出多元索引列表的接口为ListSearchIndex

参数

参数

说明

tableName

数据表名称,不能为空。

使用方式

您可以使用控制台、命令行工具或者SDK进行列出多元索引列表的操作。

进行列出多元索引列表操作之前,您需要完成如下准备工作。

  • 使用阿里云账号或者使用具有表格存储操作权限的RAM用户进行操作。如果需要为RAM用户授权表格存储操作权限,请参见通过RAM Policy为RAM用户授权进行配置。

    使用SDK方式和命令行工具方式进行操作时,如果当前无可用AccessKey,则需要为阿里云账号或者RAM用户创建AccessKey。具体操作,请参见创建AccessKey

  • 已创建数据表。具体操作,请参见数据表操作

  • 已为数据表创建多元索引。具体操作,请参见创建多元索引

  • 使用SDK方式进行操作时,还需要完成初始化Client。具体操作,请参见初始化OTSClient

  • 使用命令行工具方式进行操作前,还需要完成下载并启动命令行工具,然后配置接入实例信息并选择要操作的表。具体操作,请参见下载命令行工具启动并配置数据表操作

使用控制台

通过控制台列出指定数据表下的多元索引列表。

  1. 进入索引管理页签。

    1. 登录表格存储控制台

    2. 在页面上方,选择资源组和地域。

    3. 概览页面,单击实例名称或在操作列单击实例管理

    4. 实例详情页签下的数据表列表页签,单击数据表名称或在操作列单击索引管理

  2. 索引管理页签,即可查看数据表下的多元索引列表。

使用命令行工具

通过命令行工具执行list_search_index命令列出多元索引列表。更多信息,请参见多元索引

以下示例用于查看当前表下的多元索引列表。

list_search_index

返回结果示例如下所示。

+-----------+--------------+
| TableName | IndexName    |
+-----------+--------------+
| mytable   | search_index |
+-----------+--------------+

使用SDK

您可以通过Java SDKGo SDKPython SDKNode.js SDK.NET SDKPHP SDK列出多元索引列表。此处以Java SDK为例介绍列出多元索引列表的操作。

以下示例用于列出指定表的多元索引列表。

private static List<SearchIndexInfo> listSearchIndex(SyncClient client) {
    ListSearchIndexRequest request = new ListSearchIndexRequest();
    //设置数据表名称。
    request.setTableName("<TABLE_NAME>"); 
    //获取数据表关联的所有多元索引。
    return client.listSearchIndex(request).getIndexInfos();
}

相关文档

  • 如果要查询某个多元索引的详细信息,例如多元索引的字段信息、索引结构等,您可以使用查询多元索引描述信息功能实现。具体操作,请参见查询多元索引描述信息

  • 如果不再使用某个多元索引,您可以删除该多元索引。具体操作,请参见删除多元索引