Consulta datos mediante índices de búsqueda.
Sintaxis de la solicitud
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 |
Obligatorio |
Descripción |
|
table_name |
string |
Sí |
El nombre de la tabla de datos. |
|
index_name |
string |
Sí |
El nombre del índice de búsqueda. |
|
columns_to_get |
No |
Las columnas que desea devolver. |
|
|
search_query |
bytes |
Sí |
La configuración de la consulta. El valor debe estar codificado en protobuf. Para obtener más información sobre los elementos de configuración, consulte SearchQuery. |
|
routing_values |
bytes |
No |
La clave de enrutamiento. |
|
timeout_ms |
int32 |
No |
El periodo de tiempo de espera de la consulta. Unidad: milisegundos. |
Sintaxis de la respuesta
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 |
Descripción |
|
total_hits |
int64 |
El número total de filas coincidentes. |
|
rows |
bytes |
La información sobre las filas. El valor está codificado en PlainBuffer. Para obtener más información, consulte PlainBuffer. |
|
search_hits |
Las filas coincidentes devueltas. Este valor de retorno solo existe cuando se utiliza la función de resaltado o de consulta vectorial KNN. |
|
|
is_all_succeeded |
bool |
Indica si la consulta fue exitosa. |
|
next_token |
bytes |
La posición desde la cual comienza la siguiente lectura de datos. Si se devuelven todas las filas de datos que cumplen la condición, el valor de este parámetro estará vacío. |
|
aggs |
bytes |
La operación de agregación realizada en las filas de datos, como calcular el valor máximo, el valor mínimo, el valor promedio o el recuento de filas. Los resultados de la agregación están codificados en protobuf. |
|
group_bys |
bytes |
Agrupa las filas de datos por valor de campo o por rango. Los resultados de la agrupación están codificados en protobuf. |
|
consumed |
El número de unidades de capacidad medidas consumidas por la operación. |
|
|
reserved_consumed |
El número de unidades de capacidad reservadas consumidas por la operación. |