Todos os produtos
Search
Central de documentação

Tablestore:Consulta por prefixo

Última atualização: Sep 20, 2026

Use a consulta por prefixo para encontrar dados que correspondam ao prefixo especificado. Quando a coluna utilizada para a correspondência de prefixo é do tipo TEXT, o conteúdo é tokenizado. Uma linha atende às condições de consulta quando ao menos um token contém o prefixo especificado.

Pré-requisitos

Parâmetros

Parâmetro

Descrição

table_name

O nome da tabela de dados.

index_name

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 a quantidade de linhas que atendem às condições sem retornar os dados específicos, defina este parâmetro como 0.

get_total_count

Especifica se o número total de linhas que atendem às condições de consulta deve ser retornado. Valor padrão: false. O valor false indica que o total de linhas não é retornado.

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

query_type

O tipo de consulta. Para usar a consulta por prefixo, defina este parâmetro como QueryTypeConst::PREFIX_QUERY.

field_name

O nome da coluna a ser consultada.

prefix

O prefixo.

Quando a coluna utilizada para a correspondência de prefixo é do tipo TEXT, o conteúdo é tokenizado. Uma linha atende às condições de consulta quando ao menos um token contém o prefixo especificado.

sort

O método de ordenação das linhas na resposta. Para mais informações, consulte Sorting and paging.

columns_to_get

Especifica se todas as colunas de cada linha que atende às condições de consulta devem ser retornadas. Configure return_type e return_names para este parâmetro.

  • Se return_type for definido como ColumnReturnTypeConst::RETURN_SPECIFIED, use return_names para especificar as colunas a retornar.

  • Se return_type for definido como ColumnReturnTypeConst::RETURN_ALL, todas as colunas são retornadas.

  • Se return_type for definido como ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX, todas as colunas do índice de pesquisa são retornadas.

  • Se return_type for definido como ColumnReturnTypeConst::RETURN_NONE, apenas as colunas de chave primária são retornadas.

Exemplos

O exemplo de código a seguir mostra como consultar todas as linhas que contêm o prefixo "key" na coluna keyword de uma tabela de dados.

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 2,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::PREFIX_QUERY,
            'query' => array(
                'field_name' => 'keyword',
                'prefix' => 'key'
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword',
                    'order' => SortOrderConst::SORT_ORDER_ASC
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_ALL,
        'return_names' => array('keyword')
    )
);
$response = $otsClient->search($request);

FAQ

Referências

  • Ao usar um índice de pesquisa para consultar dados, os seguintes métodos de consulta estão disponíveis: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, Boolean query, geo query, nested query e exists query. Combine diferentes métodos de consulta para buscar dados em múltiplas dimensões conforme suas necessidades de negócio.

    Para ordenar ou paginar as linhas que atendem às condições de consulta, utilize o recurso de ordenação e paginação. Para mais informações, consulte Sorting and paging.

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

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

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