全部產品
Search
文件中心

:Search

更新時間:Jun 30, 2024

調用Search介面通過多元索引查詢資料。

請求訊息結構

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;
    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

對資料行進行統計彙總,例如求最值、求平均值、統計行數等,由protobuf編碼。

group_bys

bytes

對資料行進行分組,例如按照欄位值分組、按照範圍分組等,由protobuf編碼。

使用SDK