创建多元索引后,使用ListSearchIndex接口可以获取某个数据表关联的所有多元索引的列表信息。
前提条件
- 已初始化OTSClient。具体操作,请参见初始化OTSClient。
- 已创建数据表并写入数据。
- 已在数据表上创建多元索引。具体操作,请参见创建多元索引。
接口
/**
* 获取该数据表下所有的多元索引名称。
* @api
*
* @param [] $request
* 请求参数,数据表名称。
* @return [] 请求返回。
* @throws OTSClientException 当参数检查出错或服务端返回校验出错时抛出异常。
* @throws OTSServerException 当OTS服务端返回错误时抛出异常。
* @example "src/examples/ListSearchIndex.php"
*/
public function listSearchIndex(array $request)
参数
参数 | 说明 |
table_name | 数据表名称,不能为空。 |
示例
以下示例用于列出指定表的多元索引列表。
$request = array(
'table_name' => 'php_sdk_test',
);
$response = $otsClient->listSearchIndex($request);
相关文档
如果要查询某个多元索引的详细信息,例如多元索引的字段信息、索引结构等,您可以使用查询多元索引描述信息功能实现。具体操作,请参见查询多元索引描述信息。
如果不再使用某个多元索引,您可以删除该多元索引。具体操作,请参见删除多元索引。