Atividade de Exclusão do MongoDB¶

Introdução¶

Uma atividade Delete do MongoDB, usando sua conexão MongoDB, exclui dados de uma coleção do MongoDB e deve ser usado como um destino para consumir dados em uma operação.

Crie uma Atividade de Exclusão do MongoDB¶

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

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

Uma atividade Delete existente do MongoDB pode ser editada nestes locais:

• A quadro de design (consulte Menu Ações do componente em Quadro de Design).
• A aba Componentes do painel do projeto (consulte Menu Ações do componente em Guia Componentes do painel do projeto).

Configurar uma Atividade de Exclusão do MongoDB¶

Siga estas etapas para configurar uma atividade Delete do MongoDB:

• Etapa 1: Digite 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 Filter, Locale e Write Document IDs in Response.

• 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¶

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

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

• Selecione um objeto: Esta seção exibe coleções disponíveis no endpoint MongoDB.

  • Objeto MongoDB selecionado: Depois que uma coleção é selecionada, ela é listada aqui.

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

  • Atualizar: Clique no ícone de atualização ou a palavra Refresh para recarregar coleções do endpoint MongoDB. Isso pode ser útil se coleções tiverem sido 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: Na 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 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 MongoDB pode não ter sucesso. Certifique-se de estar conectado reabrindo a conexão e testando novamente as credenciais.

• Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche a configuração da atividade.

• 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Especificar Configurações¶

Nesta etapa, especifique Filter, Locale e Write Document IDs in Response. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Filtro: Insira um filtro (em MongoDB Extended JSON formato) 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 de documentos excluídos sejam gravados 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Revise os Esquemas de Dados¶

Quaisquer esquemas de solicitação ou resposta são exibidos. 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 usa 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 Delete usa XML em seus esquemas de solicitação e resposta.

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

  • Solicitação:

    Campo/nó do esquema de solicitação	Descrição
    deleteRequest	Solicitação de exclusão de documentos do banco de dados
    filter	Um filtro em [formato JSON estendido do MongoDB] [request-delete] usado para corresponder aos documentos a serem excluídos da coleção selecionada
    locale	Locale para especificar um idioma para os documentos na coleção selecionada
    documentId	Se devem ser gravados IDs de 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 (registos) eliminados
    documents	Nó representando o documents
    documentId	ID do documento excluído
    error	Nó representando quaisquer erros
    errorMessage	Mensagem de erro

• Atualizar: Clique no ícone de atualização ou a palavra Refresh para regenerar esquemas do endpoint MongoDB. Esta ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

• Voltar: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximos Passos¶

Depois de configurar uma atividade Delete do MongoDB, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode definir as configurações de operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte Menu Ações da atividade em Noções básicas do conector.

As atividades Delete do MongoDB podem ser usadas como alvo com estes 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, grave os dados em um local temporário e use esse local temporário na função de script.

Quando estiver pronto, implantar e execute a operação e validar o comportamento verificando os logs de operação.