Ir para o conteúdo

Atividade de Exclusão de Documento do Elasticsearch

Introdução

Uma atividade de Exclusão de Documento do Elasticsearch, utilizando sua conexão com Elasticsearch, exclui um documento do Elasticsearch e é destinada a ser usada como um alvo em uma operação.

Nota

Se os recursos de segurança do Elasticsearch estiverem habilitados em sua instância do Elasticsearch, você deve ter o privilégio de delete ou write índice para o índice alvo ou alias de índice.

Criar uma atividade de Exclusão de Documento do Elasticsearch

Uma instância de uma atividade de Exclusão de Documento do Elasticsearch é criada a partir de uma conexão com Elasticsearch usando seu tipo de atividade Exclusão de Documento.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade existente de Exclusão de Documento do Elasticsearch pode ser editada a partir destes locais:

Configurar uma atividade de Exclusão de Documento do Elasticsearch

Siga estas etapas para configurar uma atividade de Exclusão de Documento do Elasticsearch:

Passo 1: Insira um nome e especifique as configurações

Neste passo, forneça um nome para a atividade e insira o nome do índice contendo o documento a ser excluído:

Configuração da atividade Excluir Documento do Elasticsearch passo 1

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete esquerdo [ no campo ou clicando no ícone de variável para exibir uma lista das variáveis existentes para escolher.

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade Excluir Documento do Elasticsearch e não deve conter barras (/) ou dois pontos (:).

  • Índice: Insira o nome do índice contendo o documento a ser excluído.

  • Tempo Limite (em Milissegundos): Insira o tempo limite em milissegundos para a atividade Excluir Documento. Um tempo limite de zero nunca expira, caso em que a chamada bloqueia indefinidamente. O valor padrão é 30000.

  • Roteamento: Insira o valor de roteamento para a partição do índice.

  • Tipo de Versão: Especifique o tipo de versão a ser utilizado, um dos Interno, Externo ou Externo GTE.

  • Política de Atualização: Especifique a política de atualização a ser utilizada, uma das Imediata, Nenhuma ou Aguarde Até.

  • Salvar e Sair: Se habilitado, clique para salvar a configuração deste passo e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração deste passo e continuar para o próximo passo. A configuração não será salva até que você clique no botão Concluído no último passo.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer passo. Uma mensagem pede que você confirme que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos:

Configuração da atividade de exclusão de documento do Elasticsearch, etapa 2

  • Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante mapeamento de transformação.

!!! note "Nota" Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

O conector Elasticsearch utiliza a API REST do Elasticsearch 7.14.1. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

Os esquemas de dados consistem nesses nós e campos:

Nó/Campo do Esquema de Solicitação Descrição
id O ID do documento excluído
version A versão do documento, incrementada cada vez que o documento é atualizado
Nó/Campo do Esquema de Resposta Descrição
success Indica a exclusão bem-sucedida do documento
errorDetails Código de erro para exclusão malsucedida do documento, se aplicável
errorMsg Mensagem de erro para exclusão malsucedida do documento, se aplicável

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas a partir do endpoint do Elasticsearch. Essa ação também regenera um esquema em outros locais ao longo do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração para todas as etapas e fechar a configuração da atividade.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Excluir Documento do Elasticsearch, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para mais detalhes, consulte o menu de ações da atividade em Conceitos básicos do conector.

Atividades Excluir Documento do Elasticsearch podem ser usadas como um alvo com esses padrões de operação:

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.