Tablestore:検索インデックスの説明をクエリする

前提条件

• OTSClient インスタンスが初期化されていること。詳細については、OTSClient インスタンスの初期化を参照してください。

• データテーブルが作成され、データがテーブルに書き込まれていること。詳細については、データテーブルの作成とデータの書き込みを参照してください。

• データテーブルの検索インデックスが作成されていること。詳細については、検索インデックスの作成を参照してください。

API オペレーション

/**
 * テーブルに作成された検索インデックスの説明をクエリします。
 * @api
 *
 * @param [] $request
 *            リクエストパラメーター。テーブル名です。
 * @return [] レスポンス。
 * @throws OTSClientException パラメーターエラーが発生した場合、または Tablestore サーバーが検証エラーを返した場合にスローされる例外。
 * @throws OTSServerException Tablestore サーバーがエラーを返した場合にスローされる例外。
 * @example "src/examples/DescribeSearchIndex.php" 20
 */
public function describeSearchIndex(array $request)

パラメーター

例

次のサンプルコードは、検索インデックスの説明をクエリする方法を示しています。

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index'
);
$response = $otsClient->describeSearchIndex($request);

関連情報

既存の検索インデックスが要件を満たさなくなった場合は、新しい検索インデックスを作成するか、既存の検索インデックスのスキーマを変更してインデックスフィールドを追加、削除、または変更するか、検索インデックスの TTL 設定を調整できます。詳細については、検索インデックスの作成と検索インデックスのスキーマを動的に変更するを参照してください。