創建多元索引后,使用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);
相關文檔
如果要查詢某個多元索引的詳細信息,例如多元索引的字段信息、索引結構等,您可以使用查詢多元索引描述信息功能實現。具體操作,請參見查詢多元索引描述信息。
如果不再使用某個多元索引,您可以刪除該多元索引。具體操作,請參見刪除多元索引。
文檔內容是否對您有幫助?