調用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 | 否 | 要返回的列。 | |
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 | 返回的命中結果。當使用查詢摘要與高亮功能或向量檢索進行查詢時才有返回值。 | |
is_all_succeeded | bool | 是否全部成功。 |
next_token | bytes | 下一次數據讀取的起始位置。 如果滿足條件的數據行均已返回,則返回值為空。 |
aggs | bytes | 對數據行進行統計聚合,例如求最值、求平均值、統計行數等,由protobuf編碼。 |
group_bys | bytes | 對數據行進行分組,例如按照字段值分組、按照范圍分組等,由protobuf編碼。 |
consumed | 一次操作消耗的按量服務能力單元。 | |
reserved_consumed | 一次操作消耗的預留服務能力單元。 |
使用SDK
文檔內容是否對您有幫助?