Todos os produtos
Search
Central de documentação

Tablestore:Consulta por prefixo

Última atualização: Sep 18, 2026

Uma consulta por prefixo (PrefixQuery) localiza as linhas em um índice de pesquisa cujo valor de campo começa com uma string especificada.

Pré-requisitos

Parâmetros

Parâmetro

Descrição

tableName

O nome da tabela de dados.

indexName

O nome do índice de pesquisa.

offset

A posição a partir da qual a consulta atual começa.

limit

O número máximo de linhas que a consulta atual deve retornar.

Para consultar apenas o número de linhas que atendem às condições da consulta sem retornar dados específicos, defina o parâmetro limit como 0.

queryType

O tipo de consulta. Defina este parâmetro como TableStore.QueryType.PREFIX_QUERY.

fieldName

O nome da coluna que você deseja consultar.

prefix

O prefixo usado para corresponder ao valor da coluna ao realizar uma consulta por prefixo.

Se o tipo da coluna for TEXT, o Tablestore tokeniza a string e usa os tokens para corresponder à palavra-chave. Uma linha atende às condições da consulta quando pelo menos um dos tokens na linha corresponde ao prefixo especificado.

getTotalCount

Especifica se o número total de linhas que atendem às condições da consulta deve ser retornado. O valor padrão deste parâmetro é false, o que indica que o número total de linhas não será retornado.

Se você definir este parâmetro como true, isso afetará o desempenho da consulta.

columnToGet

Especifica se todas as colunas de cada linha que atende às condições da consulta devem ser retornadas. Você pode configurar os campos returnType e returnNames para este parâmetro.

  • Se você definir returnType como TableStore.ColumnReturnType.RETURN_SPECIFIED, configure returnNames e especifique as colunas que deseja retornar.

  • Se você definir o parâmetro returnType como TableStore.ColumnReturnType.RETURN_ALL, a consulta retornará todas as colunas.

  • Se você definir o parâmetro returnType como TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX, a consulta retornará todas as colunas no índice de pesquisa.

  • Se você definir o parâmetro returnType como TableStore.ColumnReturnType.RETURN_NONE, a consulta retornará apenas as colunas de chave primária.

Exemplo

O código de exemplo a seguir mostra como consultar as linhas nas quais o prefixo do valor da coluna Col_Keyword é "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));
});

FAQ

FAQ

Referências

  • Os índices de pesquisa suportam os seguintes 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 e exists query. Selecione um tipo de consulta para consultar dados de acordo com os requisitos do seu negócio.

    Para classificar ou paginar as linhas que atendem às condições da consulta, use o recurso de classificação e paginação. Para obter mais informações, consulte Sorting and paging.

    Para agrupar o conjunto de resultados com base em uma coluna específica, use o recurso de colapso (distinct). Dessa forma, os dados do tipo especificado aparecem apenas uma vez nos resultados da consulta. Para obter mais informações, consulte Collapse (distinct).

  • Para analisar dados em uma tabela de dados, como obter os valores extremos, a soma e o número total de linhas, execute operações de agregação ou instruções SQL. Para obter mais informações, consulte Aggregation e SQL query.

  • Para obter rapidamente todas as linhas que atendem às condições da consulta sem a necessidade de classificá-las, chame as operações ParallelScan e ComputeSplits para usar o recurso de varredura paralela. Para obter mais informações, consulte Parallel scan.