Elasticsearch

Elasticsearch é um poderoso mecanismo de busca e análise distribuído que permite indexar, pesquisar e analisar grandes volumes de dados em tempo real. É amplamente usado para potencializar recursos de busca, análise de logs e dados de eventos, observabilidade e muito mais.

Com o Elasticsearch no ZippyVendas, você ganha acesso programático às capacidades principais do Elasticsearch, incluindo:

Pesquisar documentos: Realize buscas avançadas em texto estruturado ou não estruturado usando Query DSL, com suporte para ordenação, paginação e seleção de campos.
Indexar documentos: Adicione novos documentos ou atualize existentes em qualquer índice Elasticsearch para recuperação e análise imediatas.
Obter, atualizar ou deletar documentos: Recupere, modifique ou remova documentos específicos por ID.
Operações em massa: Execute múltiplas ações de indexação ou atualização em uma única requisição para processamento de dados de alta vazão.
Gerenciar índices: Crie, delete ou obtenha detalhes sobre índices como parte da automação do seu workflow.
Monitoramento de cluster: Verifique a saúde e estatísticas da sua implantação Elasticsearch.

As ferramentas Elasticsearch do ZippyVendas funcionam tanto com ambientes auto-hospedados quanto com Elastic Cloud. Integre o Elasticsearch nos seus workflows de agentes para automatizar ingestão de dados, pesquisar em grandes conjuntos de dados, executar relatórios ou construir aplicações personalizadas com busca — tudo sem intervenção manual.

Instruções de Uso

Integre o Elasticsearch aos workflows para busca poderosa, indexação e gerenciamento de dados. Suporta operações CRUD de documentos, consultas de busca avançadas, operações em massa, gerenciamento de índices e monitoramento de cluster. Funciona tanto com implantações auto-hospedadas quanto com Elastic Cloud.

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice para pesquisar
`query`	string	Não	Query DSL como string JSON
`from`	number	Não	Offset inicial para paginação (padrão: 0)
`size`	number	Não	Número de resultados a retornar (padrão: 10)
`sort`	string	Não	Especificação de ordenação como string JSON
`sourceIncludes`	string	Não	Lista separada por vírgula de campos para incluir em _source
`sourceExcludes`	string	Não	Lista separada por vírgula de campos para excluir de _source
`trackTotalHits`	boolean	Não	Rastrear contagem total precisa de hits (padrão: true)

Saída

Parâmetro	Tipo	Descrição
`took`	number	Tempo em milissegundos que a pesquisa levou
`timed_out`	boolean	Se a pesquisa expirou
`hits`	object	Resultados da pesquisa com contagem total e documentos correspondentes
`aggregations`	json	Resultados de agregação se houver

`elasticsearch_index_document`

Indexar (criar ou atualizar) um documento no Elasticsearch.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice de destino
`documentId`	string	Não	ID do documento (gerado automaticamente se não fornecido)
`document`	string	Sim	Corpo do documento como string JSON
`refresh`	string	Não	Política de refresh: true, false ou wait_for

Saída

Parâmetro	Tipo	Descrição
`_index`	string	Índice onde o documento foi armazenado
`_id`	string	ID do documento
`_version`	number	Versão do documento
`result`	string	Resultado da operação (created ou updated)

`elasticsearch_get_document`

Recuperar um documento por ID do Elasticsearch.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice
`documentId`	string	Sim	ID do documento a recuperar
`sourceIncludes`	string	Não	Lista separada por vírgula de campos para incluir
`sourceExcludes`	string	Não	Lista separada por vírgula de campos para excluir

Saída

Parâmetro	Tipo	Descrição
`_index`	string	Nome do índice
`_id`	string	ID do documento
`_version`	number	Versão do documento
`found`	boolean	Se o documento foi encontrado
`_source`	json	Conteúdo do documento

`elasticsearch_update_document`

Atualizar parcialmente um documento no Elasticsearch usando mesclagem de doc.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice
`documentId`	string	Sim	ID do documento a atualizar
`document`	string	Sim	Documento parcial para mesclar como string JSON
`retryOnConflict`	number	Não	Número de tentativas em conflito de versão

Saída

Parâmetro	Tipo	Descrição
`_index`	string	Nome do índice
`_id`	string	ID do documento
`_version`	number	Nova versão do documento
`result`	string	Resultado da operação (updated ou noop)

`elasticsearch_delete_document`

Deletar um documento do Elasticsearch por ID.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice
`documentId`	string	Sim	ID do documento a deletar
`refresh`	string	Não	Política de refresh: true, false ou wait_for

Saída

Parâmetro	Tipo	Descrição
`_index`	string	Nome do índice
`_id`	string	ID do documento
`_version`	number	Versão do documento
`result`	string	Resultado da operação (deleted ou not_found)

`elasticsearch_bulk`

Executar múltiplas operações de index, create, delete ou update em uma única requisição para alta performance.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Não	Índice padrão para operações que não especificam um
`operations`	string	Sim	Operações em massa como string NDJSON (JSON delimitado por nova linha)
`refresh`	string	Não	Política de refresh: true, false ou wait_for

Saída

Parâmetro	Tipo	Descrição
`took`	number	Tempo em milissegundos que a operação em massa levou
`errors`	boolean	Se alguma operação teve erro
`items`	array	Resultados para cada operação

`elasticsearch_count`

Contar documentos correspondentes a uma consulta no Elasticsearch.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice para contar documentos
`query`	string	Não	Consulta opcional para filtrar documentos (string JSON)

Saída

Parâmetro	Tipo	Descrição
`count`	number	Número de documentos correspondentes à consulta
`_shards`	object	Estatísticas de shards

`elasticsearch_create_index`

Criar um novo índice com configurações e mapeamentos opcionais.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice a criar
`settings`	string	Não	Configurações do índice como string JSON
`mappings`	string	Não	Mapeamentos do índice como string JSON

Saída

Parâmetro	Tipo	Descrição
`acknowledged`	boolean	Se a requisição foi reconhecida
`shards_acknowledged`	boolean	Se os shards foram reconhecidos
`index`	string	Nome do índice criado

`elasticsearch_delete_index`

Deletar um índice e todos os seus documentos. Esta operação é irreversível.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice a deletar

Saída

Parâmetro	Tipo	Descrição
`acknowledged`	boolean	Se a deleção foi reconhecida

`elasticsearch_get_index`

Recuperar informações do índice incluindo configurações, mapeamentos e aliases.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`index`	string	Sim	Nome do índice para recuperar informações

Saída

Parâmetro	Tipo	Descrição
`index`	json	Informações do índice incluindo aliases, mapeamentos e configurações

`elasticsearch_cluster_health`

Obter o status de saúde do cluster Elasticsearch.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica
`waitForStatus`	string	Não	Aguardar até o cluster atingir este status: green, yellow ou red
`timeout`	string	Não	Timeout para a operação de espera (ex.: 30s, 1m)

Saída

Parâmetro	Tipo	Descrição
`cluster_name`	string	Nome do cluster
`status`	string	Status de saúde do cluster: green, yellow ou red
`number_of_nodes`	number	Número total de nós no cluster
`number_of_data_nodes`	number	Número de nós de dados
`active_shards`	number	Número de shards ativos
`unassigned_shards`	number	Número de shards não atribuídos

`elasticsearch_cluster_stats`

Obter estatísticas abrangentes sobre o cluster Elasticsearch.

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`deploymentType`	string	Sim	Tipo de implantação: self_hosted ou cloud
`host`	string	Não	URL do host Elasticsearch (para auto-hospedado)
`cloudId`	string	Não	ID do Elastic Cloud (para implantações cloud)
`authMethod`	string	Sim	Método de autenticação: api_key ou basic_auth
`apiKey`	string	Não	Chave de API do Elasticsearch
`username`	string	Não	Nome de usuário para autenticação básica
`password`	string	Não	Senha para autenticação básica

Saída

Parâmetro	Tipo	Descrição
`cluster_name`	string	Nome do cluster
`status`	string	Status de saúde do cluster
`nodes`	object	Estatísticas de nós incluindo contagem e versões
`indices`	object	Estatísticas de índices incluindo contagem de documentos e tamanho de armazenamento

Notas

Categoria: tools
Tipo: elasticsearch

Elasticsearch

On this page