創建多元索引后,使用DescribeSearchIndex接口可以查詢多元索引的描述信息,包括多元索引的字段信息、索引配置、計量信息、創建時間、TTL等。
前提條件
- 已初始化OTSClient。具體操作,請參見初始化OTSClient。
- 已創建數據表并寫入數據。
- 已在數據表上創建多元索引。具體操作,請參見創建多元索引。
接口
/**
* 獲取數據表的某個多元索引的詳細信息。
* @api
*
* @param [] $request
* 請求參數,數據表名稱。
* @return [] 請求返回
* @throws OTSClientException 當參數檢查出錯或服務端返回校驗出錯時拋出異常。
* @throws OTSServerException 當OTS服務端返回錯誤時拋出異常。
* @example "src/examples/DescribeSearchIndex.php" 20
*/
public function describeSearchIndex(array $request)
參數
參數 | 說明 |
table_name | 數據表名稱。 |
index_name | 多元索引名稱。 |
示例
以下示例用于查詢多元索引描述信息。
$request = array(
'table_name' => 'php_sdk_test',
'index_name' => 'php_sdk_test_search_index'
);
$response = $otsClient->describeSearchIndex($request);
相關文檔
如果已有多元索引不滿足使用需求,您可以創建新的多元索引、通過修改多元索引的Schema來增刪改多元索引字段或者根據需要調整多元索引的TTL。具體操作,請參見創建多元索引、動態修改schema。
文檔內容是否對您有幫助?