データテーブルに検索インデックスを作成した後、ListSearchIndex API を呼び出して、そのデータテーブルの検索インデックスを一覧表示できます。
前提条件
OTSClientインスタンスが初期化されていること。詳細については、OTSClientインスタンスの初期化を参照してください。
データテーブルが作成されていること。データがテーブルに書き込まれていること。詳細については、データテーブルの作成およびデータの書き込みを参照してください。
データテーブルの検索インデックスが作成されていること。詳細については、検索インデックスの作成を参照してください。
API オペレーション
/**
* データテーブルに作成されたすべての検索インデックスの名前を照会します。
* @api
*
* @param [] $request
* リクエストパラメーター。データテーブルの名前。
* @return [] レスポンス。
* @throws OTSClientException パラメーターエラーが発生した場合、または Tablestore サーバーが検証エラーを返した場合にスローされます。
* @throws OTSServerException Tablestore サーバーがエラーを返した場合にスローされます。
* @example "src/examples/ListSearchIndex.php"
*/
public function listSearchIndex(array $request)
パラメーター
|
パラメーター |
説明 |
|
table_name |
データテーブルの名前。このパラメーターは空にできません。 |
例
次のサンプルコードは、テーブルの検索インデックスを一覧表示する方法を示しています。
$request = array(
'table_name' => 'php_sdk_test',
);
$otsClient->listSearchIndex($request);
関連ドキュメント
-
検索インデックスのフィールドやスキーマといった詳細を知りたい場合は、検索インデックスの詳細情報をクエリできます。 詳細については、「検索インデックスの詳細情報をクエリする」をご参照ください。
-
検索インデックスが不要になった場合は、検索インデックスを削除できます。 詳細については、「検索インデックスの削除」をご参照ください。