Conecta-seEntrar na plataforma

Elasticsearch

Pesquisar, indexar e administrar dados no Elasticsearch.

Integrações e ferramentasBancos de dadosConexão: Credencial protegida

O que faz

Integre o Elasticsearch aos seus fluxos para buscas poderosas, indexação e gestão de dados. Permite criar, ler, atualizar e excluir documentos, fazer consultas de busca avançadas, executar operações em lote, gerenciar índices e monitorar o cluster. Funciona tanto com instalações próprias (self-hosted) quanto com o Elastic Cloud.

Quando usar: Use quando o seu fluxo precisar pesquisar, indexar e administrar dados no Elasticsearch.

Exemplo de situação: Localizar um cadastro e aproveitar seus dados nas etapas seguintes.

Antes de começar

Conexão necessária: Credencial protegida.

Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.

Passo a passo

  1. Adicione Elasticsearch ao desenho a partir da aba Blocos e ligue a entrada dele à etapa anterior.
  2. Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.
  3. Escolha a operação. O painel mostra só os campos que essa operação usa.
  4. Preencha os campos obrigatórios. Para usar um dado de uma etapa anterior, digite < e escolha o bloco e o campo.
  5. Clique em Executar com dados de teste e confira, no terminal, o que entrou e o que saiu do bloco.
  6. Só publique depois de conferir o resultado da execução de teste.

Operações

OperaçãoO que faz
BuscarBusca com o bloco Elasticsearch.
Indexar documentoIndexa documento com o bloco Elasticsearch.
Obter documentoObtém documento com o bloco Elasticsearch.
Atualizar documentoAtualiza documento com o bloco Elasticsearch.
Excluir documentoExclui documento com o bloco Elasticsearch.
Operações em loteExecuta a operação “Operações em lote” com o bloco Elasticsearch.
Contar documentosConta documentos com o bloco Elasticsearch.
Criar índiceCria índice com o bloco Elasticsearch.
Excluir índiceExclui índice com o bloco Elasticsearch.
Obter informações do índiceObtém informações do índice com o bloco Elasticsearch.
Listar índicesLista índices com o bloco Elasticsearch.
Saúde do clusterExecuta a operação “Saúde do cluster” com o bloco Elasticsearch.
Estatísticas do clusterExecuta a operação “Estatísticas do cluster” com o bloco Elasticsearch.

Campos

Mostrar campos de

  • Operação

    Escolhe qual ação este bloco executará.

    Opções:
    Buscar · Indexar documento · Obter documento · Atualizar documento · Excluir documento · Operações em lote · Contar documentos · Criar índice · Excluir índice · Obter informações do índice · Listar índices · Saúde do cluster · Estatísticas do cluster
    Padrão:
    Buscar

  • Tipo de implantação

    Escolhe uma das opções aceitas por este campo.

    Opções:
    Instalação própria (self-hosted) · Elastic Cloud
    Padrão:
    Instalação própria (self-hosted)

  • Host do Elasticsearch

    Obrigatório conforme a operação

    Endereço completo do seu servidor Elasticsearch, com protocolo e porta, usado quando a instalação é própria (ex.: https://busca.minhaempresa.com.br:9200).

    Quando aparece:
    Quando o campo “Tipo de implantação” for “Instalação própria (self-hosted)”
    Exemplo:
    https://localhost:9200

  • Cloud ID

    Obrigatório conforme a operação

    Informa o identificador exato do recurso na plataforma conectada.

    Quando aparece:
    Quando o campo “Tipo de implantação” for “Elastic Cloud”
    Exemplo:
    id-do-recurso

  • Método de autenticação

    Escolhe uma das opções aceitas por este campo.

    Opções:
    Chave de API · Autenticação básica (Basic Auth)
    Padrão:
    Chave de API

  • Chave de API

    Obrigatório conforme a operaçãoDado protegido

    Informe a chave de API codificada.

    Quando aparece:
    Quando o campo “Método de autenticação” for “Chave de API”
    Padrão:
    Segredo protegido

  • Nome de usuário

    Obrigatório conforme a operação

    Informe o nome de usuário.

    Quando aparece:
    Quando o campo “Método de autenticação” for “Autenticação básica (Basic Auth)”
    Exemplo:
    Exemplo de atendimento

  • Senha

    Obrigatório conforme a operaçãoDado protegido

    Informe a senha.

    Quando aparece:
    Quando o campo “Método de autenticação” for “Autenticação básica (Basic Auth)”
    Padrão:
    Segredo protegido

  • Nome do índice

    Obrigatório conforme a operação

    Índice do Elasticsearch em que a operação atua, que funciona como a tabela onde ficam os documentos (ex.: produtos).

    Aparece em:
    Buscar, Indexar documento, Obter documento, Atualizar documento, Excluir documento, Operações em lote, Contar documentos, Criar índice, Excluir índice, Obter informações do índice
    Exemplo:
    meu-indice

  • ID do documento

    Obrigatório conforme a operação

    Informa o identificador exato do recurso na plataforma conectada.

    Aparece em:
    Obter documento, Atualizar documento, Excluir documento
    Exemplo:
    id-do-recurso

  • Documento

    Obrigatório conforme a operação

    Informa ou seleciona o arquivo usado nesta operação.

    Aparece em:
    Indexar documento
    Exemplo:
    { "chave": "valor" }

  • Consulta de busca

    Informa a consulta usada para localizar ou transformar dados.

    Aparece em:
    Buscar
    Exemplo:
    SELECT * FROM clientes WHERE status = 'ativo'

  • Número de resultados

    Define um valor numérico, quantidade ou limite da operação.

    Aparece em:
    Buscar
    Exemplo:
    10

  • Posição inicial

    Quantos resultados pular antes de começar a devolver, para paginar a busca (ex.: 0 para a primeira página e 10 para a segunda, com 10 resultados por página).

    Aparece em:
    Buscar
    Exemplo:
    cliente@exemplo.com

  • Ordenação

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Buscar
    Exemplo:
    { "chave": "valor" }

  • Campos a incluir

    Campos do documento que devem vir no resultado, separados por vírgula (ex.: nome, preco); deixe vazio para trazer o documento inteiro.

    Aparece em:
    Buscar, Obter documento
    Exemplo:
    campo1, campo2 (separados por vírgula)

  • Campos a excluir

    Campos do documento que devem ficar de fora do resultado, separados por vírgula (ex.: descricao_completa, historico), útil para respostas mais leves.

    Aparece em:
    Buscar, Obter documento
    Exemplo:
    campo1, campo2 (separados por vírgula)

  • Operações em lote

    Obrigatório conforme a operação

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Operações em lote
    Exemplo:
    { "chave": "valor" }

  • Configurações do índice

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Criar índice
    Exemplo:
    { "chave": "valor" }

  • Mapeamentos do índice

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Criar índice
    Exemplo:
    { "chave": "valor" }

  • Atualização do índice (refresh)

    Escolhe uma das opções aceitas por este campo.

    Aparece em:
    Indexar documento, Excluir documento, Operações em lote
    Opções:
    Padrão · Aguardar · Imediata · Nenhum
    Exemplo:
    Padrão

  • Aguardar o status

    Escolhe uma das opções aceitas por este campo.

    Aparece em:
    Saúde do cluster
    Opções:
    Nenhum · Verde · Amarelo · Vermelho
    Exemplo:
    Nenhum

  • Tempo limite

    Em campos adicionais

    Define o tempo máximo de espera pela operação, normalmente em milissegundos.

    Aparece em:
    Saúde do cluster
    Exemplo:
    30000

  • Incluir índices do sistema

    Em campos adicionais

    Escolhe uma das opções aceitas por este campo.

    Aparece em:
    Listar índices
    Opções:
    Não · Sim
    Exemplo:
    Não

  • Novas tentativas em caso de conflito

    Quantas vezes o Elasticsearch tenta a atualização de novo se o documento for alterado por outro processo ao mesmo tempo (ex.: 3).

    Aparece em:
    Atualizar documento
    Exemplo:
    3

Saídas

Para usar um resultado deste bloco em uma etapa seguinte, digite < no campo e escolha o bloco e o campo. A referência tem o formato <elasticsearch.hits>: antes do ponto vai o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.

ReferênciaTipoO que contém
<elasticsearch.hits>jsonResultados da busca.
<elasticsearch.took>numberTempo gasto, em milissegundos.
<elasticsearch.timed_out>booleanIndica se a operação excedeu o tempo limite.
<elasticsearch.aggregations>jsonResultados das agregações.
<elasticsearch._index>stringNome do índice.
<elasticsearch._id>stringID do documento.
<elasticsearch._version>numberVersão do documento.
<elasticsearch._source>jsonConteúdo do documento.
<elasticsearch.result>stringResultado da operação.
<elasticsearch.found>booleanIndica se o documento foi encontrado.
<elasticsearch.errors>booleanIndica se ocorreu algum erro.
<elasticsearch.items>jsonResultados das operações em lote.
<elasticsearch.count>numberQuantidade de documentos.
<elasticsearch._shards>jsonEstatísticas dos shards (total, successful, skipped, failed).
<elasticsearch.acknowledged>booleanIndica se a operação foi confirmada.
<elasticsearch.message>stringMensagem de resumo sobre os índices listados.
<elasticsearch.cluster_name>stringNome do cluster.
<elasticsearch.status>stringStatus de saúde do cluster.
<elasticsearch.number_of_nodes>numberNúmero de nós.
<elasticsearch.indices>jsonEstatísticas dos índices.
<elasticsearch.nodes>jsonEstatísticas dos nós.

Exemplo de uso

Objetivo: Localizar um cadastro e aproveitar seus dados nas etapas seguintes.

InícioElasticsearchpróxima etapa
Operação
Buscar
Tipo de implantação
Instalação própria (self-hosted)
Host do Elasticsearch
https://localhost:9200
Cloud ID
id-do-recurso
Método de autenticação
Chave de API
Nome de usuário
Exemplo de atendimento

Os valores são ilustrativos. Teste primeiro com dados fictícios ou de homologação.

Erros comuns e como resolver

O bloco não executa
Confira se existe um caminho de setas que parte do gatilho (ou do Início) até este bloco. Blocos soltos no desenho são ignorados.
Aparece “Validação do fluxo” no terminal
Há campo obrigatório vazio. Clique no aviso, abra o bloco indicado e preencha o campo marcado.
Um campo chega vazio na etapa seguinte
Confira se a referência aponta para um bloco que já executou e para um campo que existe, como <elasticsearch.hits>. O nome antes do ponto é o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.
O campo que eu procuro não aparece
Os campos mudam conforme a operação escolhida. Escolha a operação primeiro; campos menos usados ficam em “Mostrar campos adicionais”.
Credencial ausente ou recusada
Escolha uma conexão válida do workspace. Se a senha ou a chave mudou no serviço, atualize a conexão cadastrada em vez de colar o segredo no bloco.
Não foi possível conectar ao banco
Confira endereço, porta, nome do banco e usuário da conexão, e se o banco aceita conexões vindas da plataforma (firewall e lista de IPs liberados).
O serviço recusou a chamada ou devolveu erro
Leia a mensagem no terminal: ela traz o motivo informado pelo serviço. Confira IDs, limites de uso e permissões, e teste antes com um recurso de homologação.

Blocos relacionados