Consulta dados por meio de índices de pesquisa.
Sintaxe da solicitação
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;
}|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|
table_name |
string |
Sim |
Nome da tabela de dados. |
|
index_name |
string |
Sim |
Nome do índice de pesquisa. |
|
columns_to_get |
Não |
Colunas a retornar. |
|
|
search_query |
bytes |
Sim |
Configuração da consulta. O valor deve estar codificado em protobuf. Para obter mais informações sobre os itens de configuração, consulte SearchQuery. |
|
routing_values |
bytes |
Não |
Chave de roteamento. |
|
timeout_ms |
int32 |
Não |
Tempo limite da consulta. Unidade: milissegundos. |
Sintaxe da resposta
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;
}|
Parâmetro |
Tipo |
Descrição |
|
total_hits |
int64 |
Número total de linhas correspondentes. |
|
rows |
bytes |
Informações das linhas codificadas em PlainBuffer. Para obter mais informações, consulte PlainBuffer. |
|
search_hits |
Linhas correspondentes retornadas. Esse valor existe apenas ao usar o recurso de destaque ou a consulta vetorial KNN. |
|
|
is_all_succeeded |
bool |
Indica se a consulta foi bem-sucedida. |
|
next_token |
bytes |
Posição inicial da próxima leitura de dados. Se todas as linhas que atendem à condição forem retornadas, esse parâmetro estará vazio. |
|
aggs |
bytes |
Operação de agregação executada nas linhas de dados, como cálculo de valor máximo, mínimo, média ou contagem de linhas. Os resultados da agregação são codificados em protobuf. |
|
group_bys |
bytes |
Agrupamento das linhas de dados por valor de campo ou intervalo. Os resultados do agrupamento são codificados em protobuf. |
|
consumed |
Número de unidades de capacidade medidas consumidas pela operação. |
|
|
reserved_consumed |
Número de unidades de capacidade reservadas consumidas pela operação. |