検索インデックスを作成します。
検索インデックスの詳細については、「概要」をご参照ください。
使用上の注意
検索インデックスを作成する前に、データテーブルの最大バージョン数が 1 に設定されており、データテーブルの生存時間 (TTL) が次のいずれかの条件を満たしていることを確認してください。
-
データテーブルの TTL が -1 に設定されている。これは、データテーブル内のデータが期限切れにならないことを意味します。
-
データテーブルの TTL が -1 以外の値に設定されており、データテーブルに対する更新操作が禁止されている。[]
リクエスト構文
message CreateSearchIndexRequest {
required string table_name = 1;
required string index_name = 2;
optional IndexSchema schema = 3;
optional string source_index_name = 4;
optional int32 time_to_live = 5; // 単位は秒
}
|
パラメーター |
タイプ |
必須 |
説明 |
|
table_name |
string |
はい |
データテーブルの名前。 |
|
index_name |
string |
はい |
検索インデックスの名前。 |
|
schema |
いいえ |
検索インデックスのスキーマ。 |
|
|
source_index_name |
string |
いいえ |
ソース検索インデックスの名前。このパラメーターは、スキーマを動的に変更する場合にのみ必要です。 |
|
time_to_live |
int32 |
いいえ |
検索インデックスの生存時間 (TTL)。データが保持される期間を指定します。デフォルト値:-1。単位:秒。 保持期間が time_to_live パラメーターの値を超えると、Tablestore は期限切れのデータを自動的に削除します。 time_to_live パラメーターの最小値は 86400 で、これは 1 日に相当します。値 -1 は、データが期限切れにならないことを意味します。 検索インデックスの TTL の詳細については、「検索インデックスの TTL の指定」をご参照ください。 |
レスポンス構文
message CreateSearchIndexResponse {
}
正常な呼び出しでは、HTTP ステータスコード 200 が返されます。その他のステータスコードは失敗を示します。
HTTP 200:呼び出しが成功しました。
-
HTTP 400 または 500:呼び出しが失敗しました。
応答にはエラーメッセージが含まれます。詳細については、「Error」をご参照ください。
Tablestore SDK の使用
次の Tablestore SDK を使用して、検索インデックスを作成できます。
-
Tablestore SDK for Java : 検索インデックスの作成
-
Tablestore SDK for Go : 検索インデックスの作成
-
Tablestore SDK for Python : 検索インデックスの作成
-
Tablestore SDK for Node.js : 検索インデックスの作成
-
Tablestore SDK for .NET : 検索インデックスの作成
-
Tablestore SDK for PHP : 検索インデックスの作成