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

Una consulta de términos con el Tablestore SDK for Java compara los valores de un campo o tokens con los términos de búsqueda y devuelve las filas coincidentes o su conteo total cuando hay una coincidencia exacta.

Requisitos previos

Instale Tablestore SDK for Java e inicialice el cliente.

Descripción de la función

Una consulta de términos compara un campo específico con varios términos de búsqueda y devuelve una fila si algún término cumple la condición de coincidencia exacta. En campos que no son de texto, como Keyword y Long, el valor completo del campo debe ser exactamente igual a uno de los términos de búsqueda. Esta combinación OR es similar a la condición IN de SQL. En un campo Text (consulte String types), la fila coincide si algún token generado por el analizador es exactamente igual a uno de los términos de búsqueda. Los términos de búsqueda no se tokenizan.

Nota

Los tokens generados para un campo Text pueden cambiar según la configuración del analizador, las actualizaciones del algoritmo y el uso del idioma. Evite usar una consulta de términos para buscar la cadena original completa de un campo Text. En su lugar, utilice una virtual column para asignar el campo de origen al tipo Keyword y realice la consulta sobre la columna virtual.

Para llamar a search, establezca el tipo de consulta en TermsQuery y use SearchQuery para configurar el número de filas devueltas, el seguimiento del conteo total y otros comportamientos comunes de la consulta.

SearchResponse search(SearchRequest request)

A continuación se muestra un ejemplo que busca filas cuyo valor del campo category sea exactamente igual a books o games. La consulta devuelve hasta 10 filas y el número total de filas coincidentes.

String tableName = "example_table";
String indexName = "example_index";

TermsQuery termsQuery = new TermsQuery();
termsQuery.setFieldName("category");
termsQuery.addTerm(ColumnValue.fromString("books"));
termsQuery.addTerm(ColumnValue.fromString("games"));

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(termsQuery);
searchQuery.setLimit(10);
searchQuery.setTrackTotalCount(SearchQuery.TRACK_TOTAL_COUNT);

SearchRequest request = new SearchRequest(tableName, indexName, searchQuery);
SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
columnsToGet.setReturnAll(true);
request.setColumnsToGet(columnsToGet);

SearchResponse response = client.search(request);
System.out.println(response.getTotalCount());
System.out.println(response.getRows());

Parámetros

Solicitud de búsqueda

request es un objeto SearchRequest que contiene los siguientes parámetros.

Nombre	Tipo	Descripción
tableName (obligatorio)	String	El nombre de la tabla.
indexName (obligatorio)	String	El nombre del índice de búsqueda.
searchQuery (obligatorio)	SearchQuery	La condición de consulta y la configuración general de la consulta.
columnsToGet (opcional)	SearchRequest.ColumnsToGet	La configuración de las columnas que se devolverán. Si omite este parámetro, solo se devuelven las columnas de clave principal.
timeoutInMillisecond (opcional)	int	El tiempo de espera de la consulta a nivel de solicitud, en milisegundos. El valor predeterminado es `-1`, lo que indica que no se establece un tiempo de espera específico para la consulta.
routingValues (opcional)	`List<PrimaryKey>`	Los valores de clave principal para los campos de enrutamiento personalizado. Omita este parámetro si el índice no utiliza enrutamiento personalizado.

Configuración de la consulta

request.searchQuery es un objeto SearchQuery que contiene los siguientes parámetros.

Nombre	Tipo	Descripción
query (obligatorio)	Query	La condición de consulta. Establezca este parámetro en `TermsQuery` para realizar una consulta de términos.
offset (opcional)	Integer	La posición inicial de la consulta.
limit (opcional)	Integer	El número máximo de filas que se devolverán. Establezca este parámetro en `0` para no devolver ninguna fila.
highlight (opcional)	Highlight	La configuración de resumen y resaltado para campos Text. Para más detalles sobre la configuración, consulte Summary and highlighting.
collapse (opcional)	Collapse	La configuración de colapso de campos, que elimina duplicados en los resultados según un campo especificado. Para más detalles sobre la configuración, consulte Collapse query results.
sort (opcional)	Sort	El orden de clasificación de los resultados. Para más detalles sobre la configuración, consulte Sort and paginate results.
trackTotalCount (opcional)	int	El número máximo esperado de filas coincidentes que se contarán. El valor predeterminado es `TRACK_TOTAL_COUNT_DISABLED`, que deshabilita el conteo. Establezca este parámetro en `TRACK_TOTAL_COUNT` para contar todas las filas coincidentes. Un valor menor mejora el rendimiento de la consulta.
filter (opcional)	SearchFilter	Un filtro que se aplica a los resultados de `query`.
aggregationList (opcional)	`List<Aggregation>`	La configuración de agregaciones. Para más detalles sobre la configuración, consulte Aggregation.
groupByList (opcional)	`List<GroupBy>`	La configuración de agrupación. Para más detalles sobre la configuración, consulte Aggregation.
token (opcional)	byte[]	El token de paginación. Establezca este parámetro con el valor `nextToken` de la respuesta anterior para continuar leyendo filas. Cuando establece `token`, el SDK borra `sort` porque el token ya contiene las condiciones de ordenamiento.

Condición de consulta

request.searchQuery.query es un objeto TermsQuery que contiene los siguientes parámetros.

Nombre	Tipo	Descripción
fieldName (obligatorio)	String	El nombre del campo indexado que se consultará.
terms (obligatorio)	`List<ColumnValue>`	Los términos de búsqueda. Puede especificar hasta 1,024 valores. Una fila coincide si algún término cumple la condición de coincidencia exacta. En un campo Text, cada valor se utiliza como un término 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 otorga a la condición de consulta una mayor contribución en 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 de los resultados cuando se usa `ScoreSort` para ordenar por puntuación de relevancia. Valor predeterminado: `1.0`.

Columnas devueltas

request.columnsToGet es un objeto SearchRequest.ColumnsToGet que contiene los siguientes parámetros.

Nombre	Tipo	Descripción
columns (opcional)	`List<String>`	Las columnas de atributos que se devolverán. Establezca este parámetro solo si tanto `returnAll` como `returnAllFromIndex` son `false`. Si omite este parámetro, solo se devuelven las columnas de clave principal.
returnAll (opcional)	boolean	Especifica si se deben devolver todas las columnas de atributos de la tabla. Valor predeterminado: `false`.
returnAllFromIndex (opcional)	boolean	Especifica si se deben devolver todas las columnas de atributos indexadas. Valor predeterminado: `false`. Este parámetro y `returnAll` no pueden ser ambos `true` simultáneamente.

Valores de retorno

search devuelve un objeto SearchResponse. La siguiente tabla describe los campos principales.

Nombre	Tipo	Descripción
totalCount	long	El número de filas coincidentes. Llame a `getTotalCount()` para obtener el valor. El valor devuelto depende de la configuración de `trackTotalCount`.
rows	`List<Row>`	Las filas devueltas por esta consulta. Llame a `getRows()` para obtener el valor. El número de filas no supera el valor de `limit`.
searchHits	`List<SearchHit>`	Los resultados de la consulta. Llame a `getSearchHits()` para obtener el valor. Si se configuró `highlight`, este campo contiene los datos de la fila junto con los resultados del resumen y el resaltado.
nextToken	byte[]	El token de la página siguiente. Llame a `getNextToken()` para obtener el valor. Si el valor no es `null`, establézcalo como `token` en la siguiente solicitud para continuar leyendo filas.
isAllSuccess	boolean	Indica si todas las particiones del índice se consultaron correctamente. Llame a `isAllSuccess()` para obtener el valor. Si el valor es `false`, la respuesta contiene resultados parciales y `totalCount` podría ser menor que el número real de filas coincidentes.