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

Utilice Tablestore SDK for Python para buscar un valor de campo o token que coincida exactamente con cualquier valor de consulta especificado.

Requisitos previos

Instale Tablestore SDK for Python e inicialice un cliente.

Descripción

Una consulta de términos busca coincidencias con varios valores en un campo. Una fila coincide si alguno de los valores de la consulta es una coincidencia exacta. En campos no textuales como Keyword y Long, el valor del campo debe coincidir exactamente con uno de los valores de la consulta. Este comportamiento es similar a la condición IN de SQL. En un campo Text, una fila coincide si uno de sus tokens coincide exactamente con un valor de la consulta. Los valores de la consulta no se tokenizan. La tokenización puede variar según las configuraciones del analizador, las actualizaciones del algoritmo y el idioma. No utilice una consulta de términos para buscar una cadena completa en un campo Text. Al invocar el método search, establezca el tipo de consulta en TermsQuery. Para obtener información sobre los tipos de campo, consulte String types.

TermsQuery(field_name, column_values, weight=None)

El siguiente ejemplo consulta filas en las que el campo category coincide exactamente con books o games, y devuelve hasta 10 filas junto con el número total de filas coincidentes.

query = TermsQuery("category", ["books", "games"])
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)

Parámetros

Solicitud de búsqueda

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

Nombre	Tipo	Descripción
table_name (obligatorio)	`str`	El nombre de la tabla de datos.
index_name (obligatorio)	`str`	El nombre del índice de búsqueda.
search_query (obligatorio)	`SearchQuery`	La condición de consulta y las configuraciones comunes de la consulta.
columns_to_get (opcional)	`ColumnsToGet`	La 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`	La lista de valores de clave principal para los campos de enrutamiento personalizado. No es necesario especificar este parámetro si no se ha configurado el enrutamiento personalizado.
timeout_s (opcional)	`int`	El 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`	La condición de consulta. Establezca este parámetro en `TermsQuery`.
sort (opcional)	`Sort`	El orden de clasificación de los resultados de la consulta. Para obtener 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`	El token de paginación. Establezca este parámetro con el valor `next_token` de la respuesta anterior para recuperar la página siguiente. Para obtener más información, consulte Sort and paginate results.
offset (opcional)	`int`	El desplazamiento desde el cual comienza la consulta actual. Utilice este parámetro para la paginación superficial.
limit (opcional)	`int`	El número máximo de filas a devolver. Si este parámetro se establece en `0`, no se devuelven datos de filas.
aggs (opcional)	`list[Agg]`	Las configuraciones de agregación. Para obtener más información, consulte Aggregation.
group_bys (opcional)	`list[BaseGroupBy]`	Las configuraciones de agrupación. Para obtener más información, consulte Aggregation.
collapse_field (opcional)	`Collapse`	La configuración de colapso de resultados, que elimina duplicados con base en un campo especificado. Para obtener más información, consulte Collapse query results.
highlight (opcional)	`Highlight`	La configuración de resumen y resaltado para campos `Text`. Para obtener más información, consulte Summary and highlighting.

Condición de consulta

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

Nombre	Tipo	Descripción
field_name (obligatorio)	`str`	El nombre del campo indexado que se va a consultar.
column_values (obligatorio)	`list`	La lista de valores de consulta. Se pueden especificar hasta 1,024 valores. Una fila coincide si alguno de los valores de la consulta es una coincidencia exacta. En un campo `Text`, cada valor se trata como un token completo y no se tokeniza.
weight (opcional)	`float`	El peso de relevancia de la condición de consulta. El valor debe ser un número de punto flotante positivo. Un valor mayor contribuye más a la puntuación de relevancia BM25. Este parámetro no afecta la coincidencia ni el número de filas devueltas; solo influye en el orden cuando los resultados se clasifican por puntuación de relevancia. Valor predeterminado: `1.0`.

Columnas de retorno

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

Nombre	Tipo	Descripción
column_names (opcional)	`list[str]`	Los nombres de las columnas de atributos a devolver. Especifique este parámetro únicamente cuando `return_type` sea `SPECIFIED`.
return_type (opcional)	`ColumnReturnType`	El modo de retorno 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]`	Las filas devueltas por la consulta actual. El número de filas no supera el valor de `limit`.
next_token	`bytes`	El 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`	El 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 que el número real de filas coincidentes.
agg_results	`list[AggResult]`	Los resultados de agregación. Este campo está vacío si no se configura `aggs`.
group_by_results	`list[GroupByResult]`	Los resultados de agrupación. Este campo está vacío si no se configura `group_bys`.
search_hits	`list[SearchHit]`	Los aciertos 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 así evitar errores de desempaquetado si se extienden los campos de la respuesta.

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