すべてのプロダクト
Search
ドキュメントセンター

Tablestore:CreateSearchIndex

最終更新日:Dec 28, 2024

検索インデックスを作成します。

説明

検索インデックスの詳細については、概要を参照してください。

使用方法

検索インデックスを作成する前に、データテーブルの最大バージョン数が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

IndexSchema

はい

検索インデックスのスキーマ。

source_index_name

string

いいえ

ソース検索インデックスの名前。このパラメーターは、スキーマを動的に変更する場合にのみ必要です。

time_to_live

int32

いいえ

検索インデックスのTTL。TTLは、データが保持される期間を指定します。デフォルト値:-1。単位:秒。

保持期間がtime_to_liveパラメーターの値を超えると、Tablestoreは期限切れのデータを自動的に削除します。

time_to_liveパラメーターの最小値は86400で、1日に相当します。値-1は、データが期限切れにならないことを指定します。

検索インデックスのTTLの詳細については、検索インデックスのTTLを指定するを参照してください。

レスポンス構文

message CreateSearchIndexResponse {
}

HTTPステータスコード200が返されるかどうかを確認して、呼び出しが成功したかどうかを判断します。

  • HTTPステータスコード200が返された場合、呼び出しは成功です。

  • HTTPステータスコード400または500が返された場合、呼び出しは失敗しました。

    失敗した呼び出しに対してエラーメッセージが返されます。詳細については、エラーを参照してください。

Tablestore SDKの使用

以下のTablestore SDKを使用して検索インデックスを作成できます。