Atividade de Exclusão do MongoDB

Introdução

Uma atividade de Exclusão do MongoDB, utilizando sua conexão MongoDB, exclui dados de uma coleção MongoDB e é destinada a ser usada como um destino para consumir dados em uma operação.

Criar uma atividade de Exclusão do MongoDB

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

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 de Exclusão do MongoDB existente pode ser editada a partir destes locais:

• A tela de design (veja Menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).

Configurar uma atividade de Exclusão do MongoDB

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

• Etapa 1: Insira um nome e selecione uma coleção
  Forneça um nome para a atividade e selecione uma coleção.

• Etapa 2: Especifique as configurações
  Especifique o Filtro, Localidade e IDs de Documentos de Escrita na Resposta.

• Etapa 3: Revise os esquemas de dados
  Quaisquer esquemas de solicitação ou resposta são exibidos.

Etapa 1: Insira um nome e selecione uma coleção

Neste passo, forneça um nome para a atividade e selecione uma coleção. Cada elemento da interface do usuário deste passo é descrito abaixo.

• Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Exclusão do MongoDB e não deve conter barras / ou dois pontos :.

• Selecionar um Objeto: Esta seção exibe as coleções disponíveis no endpoint do MongoDB.

  • Objeto MongoDB Selecionado: Após selecionar uma coleção, ela é listada aqui.

  • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de coleções. A pesquisa não diferencia maiúsculas de minúsculas. Se as coleções já estiverem exibidas na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar coleções do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar coleções do endpoint do MongoDB. Isso pode ser útil se coleções foram adicionadas ao MongoDB. Esta ação atualiza todos os metadados usados para construir a tabela de coleções exibida na configuração.

  • Selecionando uma Coleção: Dentro da tabela, clique em qualquer lugar de uma linha para selecionar uma coleção. Apenas uma coleção pode ser selecionada. As informações disponíveis para cada coleção são obtidas do endpoint do MongoDB:

    • Nome: O nome da coleção.

    • Descrição: A descrição da coleção.

  Dica

  Se a tabela não for preenchida com coleções disponíveis, a conexão com o MongoDB pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

• 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 mudanças feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Especificar configurações

Nesta etapa, especifique o Filtro, Localidade e Escrever IDs de Documentos na Resposta. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Filtro: Insira um filtro (no formato de JSON Estendido do MongoDB) a ser usado para corresponder aos documentos a serem excluídos da coleção selecionada.

• Localidade: Insira uma localidade para especificar um idioma para os documentos na coleção selecionada. Por exemplo, pt especifica português. Se estiver vazio, en (inglês) é usado.

• Escrever IDs de Documentos na Resposta: Selecione para especificar que os IDs dos documentos excluídos são escritos na resposta.

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

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

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

Etapa 3: Revisar os esquemas de dados

Qualquer esquema de solicitação ou resposta é exibido. Cada elemento da interface do usuário desta etapa é descrito abaixo.

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

  Nota

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

  O conector MongoDB utiliza o MongoDB Java Driver v4.1. Consulte a documentação do driver e a referência do MongoDB para obter informações sobre os nós e campos do esquema.

  A atividade Excluir utiliza XML em seus esquemas de solicitação e resposta.

  Os esquemas de dados de solicitação e resposta consistem nos seguintes nós e campos:

  • Solicitação:

    Campo/Nó do Esquema de Solicitação	Descrição
    deleteRequest	Solicitação para excluir documentos do banco de dados
    filter	Um filtro no formato JSON Estendido do MongoDB usado para corresponder aos documentos a serem excluídos da coleção selecionada
    locale	Localidade para especificar um idioma para os documentos na coleção selecionada
    documentId	Se deve escrever os IDs dos documentos na resposta

  • Resposta:

    Campo/Nó do Esquema de Resposta	Descrição
    deleteResponse	Resposta da exclusão de documentos no banco de dados
    number_of_deleted_documents	Número de documentos (registros) excluídos
    documents	Nó representando os documents
    documentId	ID do documento excluído
    error	Nó representando quaisquer erros
    errorMessage	Mensagem de erro

• Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint MongoDB. Esta 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 de 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 pede para você confirmar que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Delete do MongoDB, 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 de menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para mais detalhes, veja o menu de ações da atividade em Noções básicas sobre conectores.

As atividades Excluir do MongoDB podem ser usadas como um alvo com esses padrões de operação:

• Padrão de transformação
• Padrão de duas transformações (como o primeiro ou segundo alvo)

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.