Match all query - Tablestore SDK for Python - Tablestore - Centro de documentación de Alibaba Cloud

Utilice Tablestore SDK for Python para obtener todas las filas de un índice de búsqueda y devolver las filas coincidentes o el número total de coincidencias.

Requisitos previos

Instale Tablestore SDK for Python e inicialice un cliente.

Descripción

Una consulta de coincidencia total recupera todos los datos de un índice de búsqueda sin aplicar condiciones basadas en campos ni valores. Al invocar el método search, establezca el tipo de consulta como MatchAllQuery.

MatchAllQuery()

El siguiente ejemplo obtiene todas las filas de un índice de búsqueda y devuelve hasta 10 filas junto con el número total de coincidencias.

query = MatchAllQuery()
search_query = SearchQuery(
    query,
    limit=10,
    get_total_count=True,
)
response = client.search(
    "example_table",
    "example_index",
    search_query,
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
print(response.total_count)
for row in response.rows:
    print(row)

Nota

MatchAllQuery asigna la misma puntuación de relevancia a todas las filas coincidentes. Si no se especifica un orden de clasificación, no se garantiza el orden de las filas devueltas. Para recuperar únicamente el número total de filas coincidentes, establezca limit en 0. Habilitar el recuento total incrementa la sobrecarga de la consulta.

Parámetros

Solicitud de búsqueda

El método search incluye los siguientes parámetros.

Nombre	Tipo	Descripción
table_name (obligatorio)	`str`	Nombre de la tabla de datos.
index_name (obligatorio)	`str`	Nombre del índice de búsqueda.
search_query (obligatorio)	`SearchQuery`	Condición de consulta y configuraciones generales de la consulta.
columns_to_get (opcional)	`ColumnsToGet`	Configuración de columnas a devolver. Si no se especifica este parámetro, solo se devuelven las columnas de clave principal.
routing_keys (opcional)	`list`	Lista de valores de clave principal para campos de enrutamiento personalizado. No es necesario especificar este parámetro si no se ha configurado el enrutamiento personalizado.
timeout_s (opcional)	`int`	Tiempo de espera de la solicitud en segundos. Si no se especifica este parámetro, se utiliza el tiempo de espera definido a nivel de cliente.

Configuración de la consulta

search_query es de tipo SearchQuery e incluye los siguientes parámetros.

Nombre	Tipo	Descripción
query (obligatorio)	`Query`	Condición de consulta. Establezca este parámetro como `MatchAllQuery`.
sort (opcional)	`Sort`	Orden de clasificación de los resultados de la consulta. Para más información, consulte Sort and paginate results.
get_total_count (opcional)	`bool`	Indica si se debe devolver el número total de filas coincidentes. Valor predeterminado: `False`. Establecer este parámetro en `True` incrementa la sobrecarga de la consulta.
next_token (opcional)	`bytes`	Token de paginación. Establezca este parámetro con el valor `next_token` de la respuesta anterior para recuperar la página siguiente. Para más información, consulte Sort and paginate results.
offset (opcional)	`int`	Desplazamiento desde el cual comienza la consulta actual. Utilice este parámetro para una paginación superficial.
limit (opcional)	`int`	Número máximo de filas a devolver. Si este parámetro se establece en `0`, no se devuelve ninguna fila de datos.
aggs (opcional)	`list[Agg]`	Configuraciones de agregación. Para más información, consulte Aggregation.
group_bys (opcional)	`list[BaseGroupBy]`	Configuraciones de agrupación. Para más información, consulte Aggregation.
collapse_field (opcional)	`Collapse`	Configuración de colapso de resultados que elimina duplicados según un campo específico. Para más información, consulte Collapse query results.

Condición de consulta

search_query.query es de tipo MatchAllQuery y no contiene parámetros adicionales.

Columnas a devolver

columns_to_get es de tipo ColumnsToGet e incluye los siguientes parámetros.

Nombre	Tipo	Descripción
column_names (opcional)	`list[str]`	Nombres de las columnas de atributos a devolver. Especifique este parámetro únicamente cuando `return_type` sea `SPECIFIED`.
return_type (opcional)	`ColumnReturnType`	Modo de devolución de columnas. `NONE` (predeterminado) devuelve solo las columnas de clave principal; `SPECIFIED` devuelve las columnas de atributos indicadas en `column_names`; `ALL` devuelve todas las columnas de atributos de la tabla; y `ALL_FROM_INDEX` devuelve todas las columnas de atributos indexadas.

Respuesta

El método search devuelve un objeto SearchResponse. La siguiente tabla describe los campos principales.

Campo	Tipo	Descripción
rows	`list[Row]`	Filas devueltas por la consulta actual. El número de filas no supera el valor de `limit`.
next_token	`bytes`	Token para la página siguiente. Si este campo no está vacío, páselo a la siguiente solicitud para continuar la lectura.
total_count	`int`	Número de filas coincidentes. El valor depende de la configuración de `get_total_count`.
is_all_succeed	`bool`	Indica si se consultaron todas las particiones del índice. Si el valor es `False`, se devuelven resultados parciales y `total_count` podría ser menor al número real de filas coincidentes.
agg_results	`list[AggResult]`	Resultados de agregación. Este campo está vacío si no se configura `aggs`.
group_by_results	`list[GroupByResult]`	Resultados de agrupación. Este campo está vacío si no se configura `group_bys`.
search_hits	`list[SearchHit]`	Coincidencias de búsqueda, que incluyen información extendida como puntuaciones de relevancia, resaltados y filas secundarias coincidentes.

Respuesta compatible con tuplas

A partir de Tablestore SDK for Python 5.2.0, las API de búsqueda devuelven objetos de respuesta en lugar de tuplas. La versión 5.1.0 y anteriores devuelven tuplas directamente. En la versión 5.2.1 y posteriores, puede invocar SearchResponse.v1_response() para obtener una tupla compatible con versiones anteriores. Para código nuevo, acceda directamente a los atributos de SearchResponse y evite errores de desempaquetado si se amplían los campos de la respuesta.

(
    rows,
    next_token,
    total_count,
    is_all_succeed,
    agg_results,
    group_by_results,
    search_hits,
) = response.v1_response()