Todos os produtos
Search
Central de documentação

Tablestore:Search indexes

Última atualização: Oct 21, 2026

Crie e gerencie índices de pesquisa com a Tablestore CLI para consultar dados por colunas que não sejam chave primária e combinar várias condições.

Pré-requisitos

  • Tablestore CLI configurada com credenciais de acesso. Para mais informações, consulte Tablestore CLI.

  • Uma tabela de dados. Para mais informações, consulte Data table operations.

Criar um índice de pesquisa

create_search_index -n <indexName>

Parâmetro

Obrigatório

Descrição

-i, --input

Não

Caminho para um arquivo JSON que define o schema do índice de pesquisa. Caso não seja especificado, a CLI usa entrada interativa.

-n, --name

Sim

Nome do índice de pesquisa.

-t, --table

Não

Nome da tabela de dados. Desnecessário se já houver uma tabela de dados selecionada com o comando use.

--ttl

Não

Tempo de vida (TTL) dos dados, definindo o período de retenção. Unidade: segundos. Valor padrão: -1 (os dados nunca expiram). Valor mínimo: 86400 (um dia). O sistema exclui automaticamente os dados que excederem o TTL.

Importante

Para usar o recurso Lifecycle management do índice de pesquisa, desative a operação UpdateRow na tabela de dados. O TTL do índice de pesquisa e o da tabela de dados são independentes. O TTL do índice de pesquisa deve ser menor ou igual ao da tabela de dados.

Quando solicitado, insira o schema do índice no formato JSON ou use o parâmetro -i para especificar um arquivo de schema. O schema contém as seguintes configurações:

Parâmetro

Obrigatório

Descrição

IndexSetting

Não

Configurações do índice, incluindo RoutingFields.

RoutingFields (opcional): Campos de roteamento personalizados. Selecione colunas de chave primária como campos de roteamento. Dados com os mesmos valores de campo de roteamento são distribuídos para a mesma partição durante leituras e gravações, melhorando o desempenho da consulta. Normalmente, defina apenas um campo de roteamento. Se definir vários, o Tablestore concatena os valores em um só.

FieldSchemas

Sim

Lista de objetos FieldSchema. Cada FieldSchema contém os seguintes campos:

  • FieldName (obrigatório): Nome do campo no índice de pesquisa (nome da coluna). Tipo: String. Um campo em um índice de pesquisa pode ser uma coluna de chave primária ou de atributo.

  • FieldType (obrigatório): Os Data types do campo.

  • IsArray (opcional): Indica se o campo é um array. Tipo: Boolean. Se definido como true, a coluna é um array e os dados devem ser gravados no formato de array JSON, como ["a","b","c"]. Como Nested é um tipo de array, não é necessário definir este parâmetro quando FieldType for Nested.

  • Index (opcional): Indica se a indexação deve ser ativada. Tipo: Boolean. Valor padrão: true, criando um índice invertido ou espacial para a coluna. Se definido como false, nenhum índice será criado para a coluna.

  • Analyzer (opcional): Tipo de Tokenization. Defina este parâmetro quando o tipo de campo for Text. Se omitido, o padrão é tokenização de caractere único.

  • AnalyzerParameter: Parâmetros para o analisador SingleWord, incluindo CaseSensitive (se a correspondência diferencia maiúsculas de minúsculas; padrão: false) e DelimitWord (se deve separar palavras alfabéticas e dígitos; padrão: false).

  • EnableSortAndAgg (opcional): Indica se a ordenação e a agregação devem ser ativadas. Tipo: Boolean. Apenas campos com EnableSortAndAgg definido como true podem ser usados para sorting.

    Importante

    Campos Nested não suportam ordenação nem agregação. No entanto, subcolunas dentro de um campo Nested suportam essas operações.

  • IsVirtualField (opcional): Indica se a coluna é uma Virtual columns. Tipo: Boolean. Valor padrão: false. Se definido como true, SourceFieldNames torna-se obrigatório.

  • SourceFieldNames (opcional): Nome do campo na tabela de dados. Tipo: String. Obrigatório quando IsVirtualField estiver definido como true.

IndexSort

Não

Configurações de pré-ordenação do índice. Padrão: ordenado por chave primária.

Importante

Índices contendo campos Nested não suportam IndexSort e não admitem pré-ordenação.

Sorters (opcional): Método de pré-ordenação. Suporta ordenação por chave primária (PrimaryKeySort) e por valor de campo (FieldSort). Para mais informações, consulte Sorting and paging.

  • Name: Método de ordenação. PrimaryKeySort ordena por chave primária. FieldSort ordena por valor de campo. Apenas campos indexados com ordenação e agregação ativadas admitem pré-ordenação.

  • Sorter: Contém FieldName (nome do campo para ordenação, obrigatório para ordenação por valor de campo) e Order (ordem de classificação: ASC para crescente ou DESC para decrescente; padrão: ASC).

Exemplos

Crie um índice de pesquisa chamado search_index.

create_search_index -n search_index

Insira o schema do índice conforme solicitado. Exemplo:

{
    "IndexSetting": {
        "RoutingFields": null
    },
    "FieldSchemas": [
        {
            "FieldName": "gid",
            "FieldType": "LONG",
            "Index": true,
            "EnableSortAndAgg": true,
            "IsArray": false,
            "IsVirtualField": false
        },
        {
            "FieldName": "col3",
            "FieldType": "TEXT",
            "Index": true,
            "Analyzer": "single_word",
            "AnalyzerParameter": {
                "CaseSensitive": true,
                "DelimitWord": null
            },
            "EnableSortAndAgg": false,
            "IsArray": false,
            "IsVirtualField": false
        }
    ],
    "IndexSort": {
        "Sorters": [
            {
                "Name": "PrimaryKeySort",
                "Sorter": {
                    "Order": "ASC"
                }
            }
        ]
    }
}

Crie um índice de pesquisa a partir de um arquivo:

create_search_index -n search_index -i /tmp/indexschema.json

Listar índices de pesquisa

list_search_index

Parâmetro

Obrigatório

Descrição

-a, --all

Não

Lista índices de pesquisa de todas as tabelas de dados.

-d, --detail

Não

Exibe informações detalhadas sobre os índices de pesquisa.

-t, --table

Não

Nome da tabela de dados. Desnecessário se já houver uma tabela de dados selecionada com o comando use.

Exemplos

Liste os índices de pesquisa da tabela de dados atual com detalhes.

list_search_index -d

Visualizar detalhes do índice de pesquisa

describe_search_index -n <indexName>

Parâmetro

Obrigatório

Descrição

-n, --name

Sim

Nome do índice de pesquisa.

-o, --output

Não

Salva a saída em um arquivo JSON ou TXT local.

-t, --table

Não

Nome da tabela de dados. Desnecessário se já houver uma tabela de dados selecionada com o comando use.

Exemplos

Visualize os detalhes do índice search_index.

describe_search_index -n search_index

O campo Index schema na saída contém o schema do índice de pesquisa. TimeToLive exibe o TTL do índice de pesquisa.

Consultar dados com um índice de pesquisa

A Tablestore CLI suporta os seguintes tipos de consulta de índice de pesquisa: Term query, Terms query, Match all query, Match query, Match phrase query, Prefix query, Range query, Wildcard query, Token-based wildcard query, Boolean query, Geo query e Exists query. Escolha o tipo de consulta adequado ao seu caso de uso.

search -n <indexName> --return_all_indexed

Quando solicitado, insira as condições de consulta no formato JSON. As condições de consulta contêm as seguintes configurações:

Parâmetro

Obrigatório

Descrição

Offset

Não

Posição inicial para retorno dos resultados.

Limit

Não

Número máximo de linhas a retornar. Para obter apenas a contagem de linhas sem retornar dados, defina Limit como 0.

Collapse

Não

Configuração de agrupamento. Use este parâmetro para Collapse (remove duplicates) o conjunto de resultados por uma coluna específica. FieldName especifica o nome da coluna. Há suporte apenas para colunas inteiras, de ponto flutuante e Keyword.

Sort

Não

Ordem de classificação dos resultados. Para mais informações, consulte Define at query time. Se omitido, os resultados retornam na ordem de pré-classificação. Caso nenhuma ordem de pré-classificação esteja definida, os resultados retornam na ordem da chave primária.

GetTotalCount

Não

Indica se deve retornar o número total de linhas correspondentes. Valor padrão: false. Ativar esta opção pode aumentar a latência da consulta.

Token

Não

Token de paginação para ler os resultados restantes. Quando uma resposta não contém todas as linhas correspondentes, o servidor retorna um Token. Passe esse Token na próxima solicitação para continuar a leitura. Defina Token como null na primeira solicitação.

Query

Sim

Tipo de consulta. Tipos suportados: MatchAllQuery, MatchQuery, MatchPhraseQuery, TermQuery, TermsQuery, PrefixQuery, RangeQuery, WildcardQuery, ExistsQuery, NestedQuery, KnnVectorQuery e BoolQuery.

Aggregations

Não

Configuração de Aggregation. Suporta operações de valor mínimo, valor máximo, soma, média, contagem e contagem distinta.

  • Name: Tipo de agregação, como min, max, sum, avg ou count.

  • Aggregation: Configuração dos parâmetros de agregação, incluindo AggName (nome personalizado da agregação), Field (campo a agregar) e MissingValue (valor padrão quando o campo está vazio).

Exemplos

Consulte dados na tabela atual com search_index e retorne todas as colunas indexadas.

search -n search_index --return_all_indexed

Insira as condições de consulta conforme solicitado. O exemplo abaixo consulta linhas onde uid é igual a 10001 e calcula a média da coluna pid:

{
    "Offset": -1,
    "Limit": 10,
    "Collapse": null,
    "Sort": null,
    "GetTotalCount": true,
    "Token": null,
    "Query": {
        "Name": "TermQuery",
        "Query": {
            "FieldName": "uid",
            "Term": 10001
        }
    },
    "Aggregations": [{
        "Name": "avg",
        "Aggregation": {
            "AggName": "agg1",
            "Field": "pid"
        }
    }]
}

Excluir um índice de pesquisa

drop_search_index -n <indexName> -y

Parâmetro

Obrigatório

Descrição

-n, --name

Sim

Nome do índice de pesquisa.

-t, --table

Não

Nome da tabela de dados. Desnecessário se já houver uma tabela de dados selecionada com o comando use.

-y, --yes

Sim

Confirma a exclusão. Este parâmetro é obrigatório no comando.

Exemplos

Exclua o índice search_index.

drop_search_index -n search_index -y