Todos os produtos
Search
Central de documentação

Tablestore:Executar uma consulta de termos usando o SDK

Última atualização: Sep 22, 2026

Uma consulta de termos é semelhante a uma consulta de termo, mas aceita vários termos. A consulta retorna uma linha de dados se pelo menos uma das palavras-chave corresponder ao valor da coluna especificada. Use consultas de termos da mesma forma que o operador IN em instruções SQL.

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 inicial da consulta atual.

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 obter os dados específicos dessas linhas, defina o parâmetro limit como 0.

get_total_count

Especifica se a consulta retorna o número total de linhas que atendem às condições. Valor padrão: false, que desativa o retorno dessa contagem.

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

query_type

O tipo da consulta. Defina este parâmetro como QueryTypeConst::TERMS_QUERY.

field_name

O nome da coluna a ser consultada.

terms

As palavras-chave usadas para corresponder ao valor da coluna durante uma consulta de termos.

A consulta retorna uma linha de dados se pelo menos uma das palavras-chave corresponder ao valor da coluna.

sort

O método usado para ordenar as linhas na resposta. Para mais informações, consulte Ordenação e paginação.

columns_to_get

Especifica se a consulta deve retornar todas as colunas das linhas que atendem às condições. Para isso, especifique os parâmetros return_type e return_names.

  • Se definir return_type como ColumnReturnTypeConst::RETURN_SPECIFIED, use return_names para especificar as colunas a serem retornadas.

  • Caso defina o parâmetro return_type como ColumnReturnTypeConst::RETURN_ALL, o sistema retorna todas as colunas.

  • Ao configurar return_type como ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX, o sistema retorna todas as colunas do índice de pesquisa.

  • Quando o parâmetro return_type for ColumnReturnTypeConst::RETURN_NONE, o sistema retorna apenas as colunas de chave primária.

Exemplo

O código de exemplo a seguir mostra como consultar as linhas em que o valor da coluna keyword é "keyword" ou "php" na tabela de dados.

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 5,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::TERMS_QUERY,
            'query' => array(
                'field_name' => 'keyword',
                'terms' => array(
                    "keyword",
                    "php"
                )
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'long',
                    'order' => SortOrderConst::SORT_ORDER_DESC,
                    'mode' => SortModeConst::SORT_MODE_AVG
                )
            )
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('keyword', 'long')
    )
);
$response = $otsClient->search($request);

FAQ

Referências