Interroge les données à l'aide des index de recherche.
Syntaxe de la requête
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;
}|
Paramètre |
Type |
Obligatoire |
Description |
|
table_name |
string |
Oui |
Nom de la table de données. |
|
index_name |
string |
Oui |
Nom de l'index de recherche. |
|
columns_to_get |
Non |
Colonnes à renvoyer. |
|
|
search_query |
bytes |
Oui |
Configuration de la requête. La valeur doit être encodée en protobuf. Pour plus d'informations sur les éléments de configuration, consultez SearchQuery. |
|
routing_values |
bytes |
Non |
Clé de routage. |
|
timeout_ms |
int32 |
Non |
Délai d'expiration de la requête, en millisecondes. |
Syntaxe de la réponse
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;
}|
Paramètre |
Type |
Description |
|
total_hits |
int64 |
Nombre total de lignes correspondantes. |
|
rows |
bytes |
Informations relatives aux lignes. La valeur est encodée au format PlainBuffer. Pour plus d'informations, consultez PlainBuffer. |
|
search_hits |
Lignes correspondantes renvoyées. Cette valeur de retour n'est présente que lorsque vous utilisez la fonctionnalité de mise en surbrillance ou de requête vectorielle KNN. |
|
|
is_all_succeeded |
bool |
Indique si la requête a abouti. |
|
next_token |
bytes |
Position à partir de laquelle débute la lecture des données suivantes. Si toutes les lignes de données répondant à la condition sont renvoyées, ce paramètre est vide. |
|
aggs |
bytes |
Opération d'agrégation effectuée sur les lignes de données, telle que le calcul de la valeur maximale, minimale, moyenne ou du nombre de lignes. Les résultats d'agrégation sont encodés en protobuf. |
|
group_bys |
bytes |
Regroupe les lignes de données par valeur de champ ou par plage. Les résultats de regroupement sont encodés en protobuf. |
|
consumed |
Nombre d'unités de capacité facturées consommées par l'opération. |
|
|
reserved_consumed |
Nombre d'unités de capacité réservées consommées par l'opération. |