データテーブルの検索インデックスを作成した後、DescribeSearchIndex オペレーションを呼び出して、フィールドに関する情報や設定を含む検索インデックスの説明を照会できます。
前提条件
-
OTSClient インスタンスが初期化されています。詳細については、「OTSClient インスタンスの初期化」をご参照ください。
-
データテーブルが作成され、データがデータテーブルに書き込まれています。詳細については、「データテーブルの作成」および「データの書き込み」をご参照ください。
-
データテーブルの検索インデックスが作成されています。詳細については、「検索インデックスの作成」をご参照ください。
パラメーター
パラメーター | 説明 |
tableName | データテーブルの名前。 |
indexName | The name of the search index. |
関連ドキュメント
詳細については、「検索インデックスの管理」をご参照ください。
client.describeSearchIndex({
tableName: TABLE_NAME, // データテーブルの名前を指定します。
indexName: INDEX_NAME // 検索インデックスの名前を指定します。
}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', JSON.stringify(data, null, 2));
});References
If an existing search index no longer meets your requirements, you can create a new search index, modify the schema of the existing search index to add, remove, or modify index fields, or adjust the TTL configuration of the search index. For more information, see Create a search index, Dynamically modify the schema of a search index, and Specify the TTL of a search index.