Todos os produtos
Search
Central de documentação

Tablestore:Consulta de termos

Última atualização: Jul 03, 2026

A consulta de termos assemelha-se à consulta de termo, mas aceita várias palavras-chave. O sistema retorna uma linha de dados se pelo menos uma das palavras-chave corresponder exatamente ao valor do campo. Essa consulta funciona de modo similar ao operador IN em instruções SQL.

Pré-requisitos

Parâmetros

Parâmetro

Descrição

tableName

Nome da tabela de dados.

indexName

Nome do índice de busca.

offset

Posição inicial da consulta atual.

limit

Número máximo de linhas a retornar na consulta atual.

Para obter apenas a contagem de linhas que atendem aos critérios de consulta, sem recuperar os dados, defina o parâmetro limit como 0.

queryType

Tipo da consulta. Para usar a consulta de termos, defina este parâmetro como TableStore.QueryType.TERMS_QUERY.

fieldName

Nome do campo a ser correspondido.

terms

Palavras-chave usadas para comparar com o valor do campo durante a consulta de termos.

O sistema retorna uma linha de dados se pelo menos uma das palavras-chave corresponder exatamente ao valor do campo.

getTotalCount

Define se o total de linhas que atendem aos critérios de consulta será retornado. Valor padrão: false.

Definir este parâmetro como true pode reduzir o desempenho da consulta.

columnToGet

Determina quais colunas retornar para cada linha que atenda aos critérios de consulta. Configure returnType e returnNames neste parâmetro.

  • Se returnType for TableStore.ColumnReturnType.RETURN_SPECIFIED, configure returnNames para especificar as colunas a retornar.

  • Se returnType for TableStore.ColumnReturnType.RETURN_ALL, todas as colunas serão retornadas.

  • Se returnType for TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX, todas as colunas do índice de busca serão retornadas.

  • Se returnType for TableStore.ColumnReturnType.RETURN_NONE, apenas as colunas de chave primária serão retornadas.

Exemplos

O exemplo de código a seguir consulta linhas em que o valor da coluna Col_Keyword corresponde exatamente a "hangzhou" ou "shanghai":

/**
 * Search the table for rows in which the value of the Col_Keyword column exactly matches "hangzhou" or "shanghai". 
 * TermsQuery supports multiple terms. You can retrieve query results that match at least one of the terms. 
 */
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.TERMS_QUERY. 
            queryType: TableStore.QueryType.TERMS_QUERY,
            query: {
                fieldName: "Col_Keyword",
                terms: ["hangzhou", "shanghai"]
            }
        },
        getTotalCount: true // Specify whether to return the total number of rows that meet the query conditions. Default value: false. 
    },
    columnToGet: { // Specify the columns that you want to return. You can set the parameter to RETURN_SPECIFIED to return the specified 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));
});

Perguntas frequentes

Perguntas frequentes

Referências