Perform prefix queries by using Tablestore SDK for Node.js - Tablestore

Una consulta de prefijo (PrefixQuery) busca las filas de un índice de búsqueda donde el valor de un campo comienza con una cadena específica.

Requisitos previos

Se inicializó una instancia de OTSClient. Para obtener más información, consulte Initialize an OTSClient instance.
Se creó una tabla de datos y se escribieron datos en ella. Para obtener más información, consulte Create data tables y Write data.
Se creó un índice de búsqueda para la tabla de datos. Para obtener más información, consulte Create a search index.

Parámetros

Parámetro	Descripción
tableName	El nombre de la tabla de datos.
indexName	El nombre del índice de búsqueda.
offset	La posición desde la que inicia la consulta actual.
limit	El número máximo de filas que debe devolver la consulta actual. Si solo necesita consultar la cantidad de filas que cumplen las condiciones, sin requerir los datos específicos, establezca el parámetro limit en 0.
queryType	El tipo de consulta. Establezca este parámetro en TableStore.QueryType.PREFIX_QUERY.
fieldName	El nombre de la columna que desea consultar.
prefix	El prefijo que se usa para coincidir con el valor de la columna durante la consulta de prefijo. Si el tipo de la columna es TEXT, Tablestore divide la cadena en tokens y los utiliza para buscar coincidencias con la palabra clave. Una fila cumple las condiciones de la consulta cuando como mínimo uno de sus tokens coincide con el prefijo especificado.
getTotalCount	Indica si se devuelve el número total de filas que cumplen las condiciones de la consulta. El valor predeterminado de este parámetro es false, lo que significa que no se devuelve dicho total. Si establece este parámetro en true, el rendimiento de la consulta se ve afectado.
columnToGet	Indica si se devuelven todas las columnas de cada fila que cumple las condiciones de la consulta. Para este parámetro, configure los campos returnType y returnNames. Si establece returnType en TableStore.ColumnReturnType.RETURN_SPECIFIED, configure returnNames para indicar las columnas que desea devolver. Si establece el parámetro returnType en TableStore.ColumnReturnType.RETURN_ALL, se devuelven todas las columnas. Si establece el parámetro returnType en TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX, se devuelven todas las columnas del índice de búsqueda. Si establece el parámetro returnType en TableStore.ColumnReturnType.RETURN_NONE, solo se devuelven las columnas de clave principal.

Ejemplo

A continuación se muestra un ejemplo de código para consultar las filas cuyo valor en la columna Col_Keyword tiene el prefijo "hang":

/**
 * Search the table for rows in which the value of Col_Keyword contains the "hang" prefix, such as "hangzhou". 
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // To query only the number of rows that meet the query conditions without specific data, set the limit parameter to 0. 
        query: { // Set the query type to TableStore.QueryType.PREFIX_QUERY. 
            queryType: TableStore.QueryType.PREFIX_QUERY,
            query: {
                fieldName: "Col_Keyword",
                prefix: "hang" // Set the prefix to "hang" to match column values such as "hangzhou" or "hangzhoushi". 
            }
        },
        getTotalCount: true // Specify whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which specifies that the total number of rows that meet the query conditions is not returned. 
    },
    columnToGet: { // Specify the columns that you want to return. You can set the parameter to RETURN_SPECIFIED to return specific columns, RETURN_ALL to return all columns, RETURN_ALL_FROM_INDEX to return all columns in the search index, or RETURN_NONE to return only the primary key columns. 
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

Preguntas frecuentes

Referencias

Los índices de búsqueda son compatibles con los siguientes tipos de consulta: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, Boolean query, geo query, nested query, vector query y exists query. Seleccione el tipo de consulta adecuado según sus necesidades de negocio.

Si necesita ordenar o paginar las filas que cumplen las condiciones de la consulta, utilice la función de ordenamiento y paginación. Para obtener más información, consulte Sorting and paging.

Para agrupar el conjunto de resultados con base en una columna específica, utilice la función de contracción (distinct). De esta manera, los datos del tipo indicado aparecen una sola vez en los resultados de la consulta. Para obtener más información, consulte Collapse (distinct).
Si requiere analizar los datos de una tabla, por ejemplo, para obtener valores extremos, sumas o el número total de filas, ejecute operaciones de agregación o sentencias SQL. Para obtener más información, consulte Aggregation y SQL query.
Cuando necesite obtener rápidamente todas las filas que cumplen las condiciones de la consulta, sin necesidad de ordenarlas, llame a las operaciones ParallelScan y ComputeSplits para usar la función de escaneo paralelo. Para obtener más información, consulte Parallel scan.