调用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;
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 | 返回的命中结果。当使用查询摘要与高亮功能或向量检索进行查询时才有返回值。 |
is_all_succeeded | bool | 是否全部成功。 |
next_token | bytes | 下一次数据读取的起始位置。 如果满足条件的数据行均已返回，则返回值为空。 |
aggs | bytes | 对数据行进行统计聚合，例如求最值、求平均值、统计行数等，由protobuf编码。 |
group_bys | bytes | 对数据行进行分组，例如按照字段值分组、按照范围分组等，由protobuf编码。 |
consumed | ConsumedCapacity | 一次操作消耗的按量服务能力单元。 |
reserved_consumed | ConsumedCapacity | 一次操作消耗的预留服务能力单元。 |
使用SDK
Java SDK：数据查询和统计聚合
Go SDK：数据查询和统计聚合
Python SDK：数据查询和统计聚合
Node.js SDK：数据查询和统计聚合
.NET SDK：数据查询和统计聚合
PHP SDK：数据查询和统计聚合