Todos os produtos
Search
Central de documentação

Tablestore:Consulta de prefixo

Última atualização: Jul 03, 2026

Use a consulta de prefixo para buscar dados correspondentes a um prefixo especificado. Se a coluna usada na condição de prefixo for do tipo TEXT, ela será tokenizada. Uma linha atenderá aos critérios da consulta quando pelo menos um token contiver o prefixo definido.

Pré-requisitos

Parâmetros

Parâmetro

Descrição

table_name

Nome da tabela de dados.

index_name

Nome do índice de busca.

offset

Posição inicial da consulta atual.

limit

Número máximo de linhas retornadas pela consulta atual.

Defina este parâmetro como 0 para obter apenas a contagem de linhas correspondentes, sem recuperar os dados específicos.

get_total_count

Indica se o total de linhas correspondentes deve ser retornado. Valor padrão: false. Quando definido como false, a contagem total não é incluída na resposta.

Habilitar esta opção (true) pode impactar o desempenho da consulta.

query_type

Tipo de consulta. Para executar uma consulta de prefixo, defina este parâmetro como QueryTypeConst::PREFIX_QUERY.

field_name

Nome da coluna a ser consultada.

prefix

Prefixo desejado.

Se a coluna alvo for do tipo TEXT, o sistema a tokeniza automaticamente. A linha será considerada correspondente se qualquer token gerado contiver o prefixo informado.

sort

Critério de ordenação das linhas na resposta. Para mais informações, consulte Ordenação e paginação.

columns_to_get

Define quais colunas retornar para cada linha correspondente. Configure return_type e return_names conforme necessário.

  • Ao definir return_type como ColumnReturnTypeConst::RETURN_SPECIFIED, use return_names para listar as colunas desejadas.

  • Se return_type for ColumnReturnTypeConst::RETURN_ALL, todas as colunas serão incluídas no resultado.

  • Com return_type definido como ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX, o sistema retorna todas as colunas presentes no índice de busca.

  • Quando return_type é ColumnReturnTypeConst::RETURN_NONE, apenas as colunas de chave primária são retornadas.

Exemplos

O código abaixo demonstra como buscar todas as linhas cuja coluna keyword contenha o prefixo "key" em 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