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 |
|
--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:
|
|
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.
|
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 |
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 |
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
|
Parâmetro |
Obrigatório |
Descrição |
|
-c, --column |
Não |
Colunas a retornar. Separe vários nomes de coluna com vírgulas (,). |
|
-n, --name |
Sim |
Nome do índice de pesquisa. |
|
-f, --print_format |
Não |
Formato de saída. Valor padrão: table. |
|
--return_all |
Não |
Retorna todas as colunas. |
|
--return_all_indexed |
Não |
Retorna todas as colunas indexadas no í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 |
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.
|
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 |
|
-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