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

Tablestore:検索

最終更新日:Feb 07, 2025

検索インデックスを使用してデータをクエリします。

リクエスト構文

message SearchRequest {
    optional string table_name = 1;
    optional string index_name = 2;
    optional ColumnsToGet columns_to_get = 3;
    optional bytes search_query = 4;
    repeated bytes routing_values = 5;
    optional int32 timeout_ms = 6;
}

パラメーター

必須

説明

table_name

string

はい

データテーブルの名前。

index_name

string

はい

検索インデックスの名前。

columns_to_get

ColumnsToGet

いいえ

返す列。

search_query

bytes

はい

クエリ構成。値は protobuf でエンコードする必要があります。構成項目の詳細については、「SearchQuery」をご参照ください。

routing_values

bytes

いいえ

ルーティングキー。

timeout_ms

int32

いいえ

クエリのタイムアウト期間。単位:ミリ秒。

レスポンス構文

message SearchResponse {
    optional int64 total_hits = 1;
    repeated bytes rows = 2;
    repeated SearchHit search_hits = 5;
    optional bool is_all_succeeded = 3;
    optional bytes next_token = 6;
    optional bytes aggs = 7;
    optional bytes group_bys = 8;
    optional ConsumedCapacity consumed = 9;
    optional ConsumedCapacity reserved_consumed = 10;
}

パラメーター

説明

total_hits

int64

一致した行の総数。

rows

bytes

行に関する情報。値は PlainBuffer でエンコードされています。詳細については、「PlainBuffer」をご参照ください。

search_hits

SearchHit

返された一致行。戻り値は、ハイライトまたは KNN ベクタークエリ機能を使用する場合にのみ存在します。

is_all_succeeded

bool

クエリが成功したかどうかを示します。

next_token

bytes

次のデータ読み取りの開始位置。

条件を満たすすべてのデータ行が返された場合、このパラメーターの値は空です。

aggs

bytes

データ行に対して実行される集計操作 (最大値、最小値、平均値、または行数の計算など)。集計結果は protobuf でエンコードされます。

group_bys

bytes

フィールド値または範囲別にデータ行をグループ化します。グループ化結果は protobuf でエンコードされます。

consumed

ConsumedCapacity

操作で消費されたメーター容量単位の数。

reserved_consumed

ConsumedCapacity

操作で消費された予約容量単位の数。

Tablestore SDK の使用