データテーブルの検索インデックスを作成した後、DescribeSearchIndex オペレーションを呼び出して、検索インデックスのフィールドと設定に関する情報など、検索インデックスの説明をクエリできます。
前提条件
OTSClient インスタンスが初期化されていること。詳細については、OTSClient インスタンスの初期化を参照してください。
データテーブルが作成され、データがデータテーブルに書き込まれていること。詳細については、データテーブルの作成とデータの書き込みを参照してください。
データテーブルの検索インデックスが作成されていること。詳細については、検索インデックスの作成を参照してください。
パラメーター
パラメーター | 説明 |
tableName | データテーブルの名前。 |
indexName | 検索インデックスの名前。 |
例
次のサンプルコードは、有効期限 (TTL)、作成時間、同期状態、フィールド情報など、検索インデックスの詳細をクエリする方法の例を示しています。
private static DescribeSearchIndexResponse describeSearchIndex(SyncClient client) {
DescribeSearchIndexRequest request = new DescribeSearchIndexRequest();
// データテーブルの名前を指定します。
request.setTableName("<TABLE_NAME>");
// 検索インデックスの名前を指定します。
request.setIndexName("<INDEX_NAME>");
DescribeSearchIndexResponse response = client.describeSearchIndex(request);
// レスポンスの詳細を表示します。
System.out.println(response.jsonize());
// 検索インデックス内のデータの同期状態を表示します。
System.out.println(response.getSyncStat().getSyncPhase().name());
return response;
}
参照
既存の検索インデックスが要件を満たさなくなった場合は、新しい検索インデックスを作成するか、既存の検索インデックスのスキーマを変更してインデックスフィールドを追加、削除、または変更するか、検索インデックスの TTL 設定を調整できます。詳細については、検索インデックスの作成、検索インデックスのスキーマを動的に変更する、および検索インデックスの TTL を構成するを参照してください。