Todos os produtos
Search
Central de documentação

Tablestore:Executar uma consulta de prefixo

Última atualização: Jul 03, 2026

A consulta de prefixo permite buscar dados cujo prefixo corresponda ao valor especificado. Se a coluna usada para avaliar as condições da consulta for do tipo TEXT, o valor dessa coluna será tokenizado. Uma linha atenderá aos critérios quando o valor tokenizado da coluna indicada contiver pelo menos um termo que inclua o prefixo definido.

Pré-requisitos

Parâmetros

Parâmetro

Descrição

FieldName

Nome da coluna a ser consultada.

Prefix

Prefixo usado para correspondência com o valor da coluna durante a consulta.

Se a coluna usada na condição for do tipo TEXT, seu conteúdo será tokenizado. A linha atenderá aos critérios se o valor tokenizado contiver pelo menos um termo que inclua o prefixo especificado.

GetTotalCount

Define se o total de linhas correspondentes às condições deve ser retornado. Valor padrão: false, indicando que essa contagem não será incluída na resposta.

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

Query

Tipo de consulta. Defina este parâmetro como PrefixQuery.

TableName

Nome da tabela de dados.

IndexName

Nome do índice de pesquisa.

ColumnsToGet

Controla quais colunas das linhas correspondentes devem ser retornadas. É possível configurar os parâmetros ReturnAll, Columns e ReturnAllFromIndex.

Por padrão, ReturnAll é false, o que significa que apenas as colunas de chave primária são retornadas. Para incluir outras colunas, utilize uma das opções abaixo:

  • Defina Columns para especificar exatamente quais colunas retornar.

  • Configure ReturnAllFromIndex como true para obter todas as colunas presentes no índice de pesquisa.

Defina ReturnAll como true para retornar todas as colunas da tabela de dados.

Exemplo

O código de exemplo a seguir demonstra como buscar linhas em que o valor da coluna Keyword_type_col contenha o prefixo "Search" dentro de uma tabela.

/// <summary>
/// Query the rows in which the value of the Keyword_type_col column contains the "Search" prefix in a table. 
/// </summary>
/// <param name="otsClient"></param>
public static void PrefixQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    // Set the query type to PrefixQuery, the column that you want to match to Keyword_type_col, and the prefix to "Search". 
    searchQuery.Query = new PrefixQuery("Keyword_type_col", "Search");
    // Return the total number of rows that meet the query conditions. 
    searchQuery.GetTotalCount = true;
    var request = new SearchRequest(TableName, IndexName, searchQuery);
    // You can specify the ColumnsToGet parameter to return the columns that you specify, all columns in the rows that meet the query conditions, or all columns in the search index. If you do not specify this parameter, only the primary key columns are returned. 
    request.ColumnsToGet = new ColumnsToGet()
    {
        // Return all columns in the search index. 
        ReturnAllFromIndex = true
        // Return the columns that you specify. 
        //Columns = new List<string>() { Long_type_col, Text_type_col, Keyword_type_col }
        // Return all columns in the rows that meet the query conditions. 
        //ReturnAll = true         
    };

    var response = otsClient.Search(request);

    Console.WriteLine("Total Count:" + response.TotalCount); // Display the total number of rows that meet the query conditions instead of the number of returned rows. 
}

Perguntas frequentes

Referências