検索インデックスを使用してデータをクエリします。
リクエスト構文
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 | いいえ | 返す列。 | |
search_query | bytes | はい | クエリ構成。値はprotobufでエンコードする必要があります。構成項目の詳細については、SearchQuery を参照してください。 |
routing_values | bytes | いいえ | ルーティングキー。 |
timeout_ms | int32 | いいえ | リクエストのタイムアウト期間。単位：ミリ秒。 |
レスポンス構文
message SearchResponse {
optional int64 total_hits = 1;
repeated bytes rows = 2;
optional bool is_all_succeeded = 3;
optional bytes next_token = 6;
optional bytes aggs = 7;
optional bytes group_bys = 8;
}パラメーター | タイプ | 必須 | 説明 |
total_hits | int64 | いいえ | 一致した行の合計数。 |
rows | bytes | いいえ | 行に関する情報。値はPlainBufferでエンコードされています。詳細については、PlainBuffer を参照してください。 |
is_all_succeeded | bool | いいえ | クエリが成功したかどうかを示します。 |
next_token | bytes | いいえ | 次のデータ読み取りの開始位置。 条件を満たすすべてのデータ行が返された場合、戻り値は空です。 |
aggs | bytes | いいえ | データ行に対して実行される集計操作 (最大値、最小値、平均値、または行数の計算など)。 |
group_bys | bytes | いいえ | データ行のグループ化方法 (フィールド値によるグループ化、範囲によるグループ化など) を示します。値はprotobufでエンコードされています。 |