Atividade de Consulta MongoDB

Introdução

Uma atividade de Consulta MongoDB, utilizando sua conexão MongoDB, recupera dados de uma coleção MongoDB e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta MongoDB

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

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 Consulta 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 Consulta MongoDB

Siga estas etapas para configurar uma atividade de Consulta 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, Limite, Tipo de Projeção e Projeção.

• 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 Consulta 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 uma coleção ser selecionada, 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 em 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 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 & 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 etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Especificar configurações

Nesta etapa, especifique o Filtro, Limite, Tipo de Projeção e Projeção. 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 ao buscar documentos da coleção especificada.

• Limite: Insira o número máximo de documentos a serem buscados da coleção.

• Tipo de Projeção: Selecione um tipo de projeção, Incluir ou Excluir:

  • Incluir: Retorna certos campos (especificados no campo Projeção) na resposta.

  • Excluir: Exclui certos campos (especificados no campo Projeção) da resposta.

• Projeção: Insira uma projeção para incluir ou excluir campos retornados na resposta da Consulta. Vários valores devem ser separados por uma vírgula.

• Ordenar: Defina a ordem de classificação da resposta desta atividade. Clique no ícone de adicionar para adicionar uma Propriedade e Tipo de Ordenação à tabela abaixo:

• Propriedade: Insira o nome do campo que está sendo ordenado.

• Tipo de Ordenação: Especifique se os documentos que contêm o campo estão ordenados em ordem crescente (1) ou decrescente (-1).

Para salvar a linha, clique no ícone de enviar na coluna mais à direita.

Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de editar ou o ícone de excluir .

Para excluir todas as linhas, clique em Limpar Tudo.

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

• Próximo: Clique para armazenar temporariamente a configuração para esta 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 alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 3: Revisar 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 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 Query 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
    queryRequest	Solicitação para consultar o banco de dados
    filter	Um filtro no formato JSON Estendido do MongoDB usado para corresponder aos documentos na coleção selecionada
    projection	A string de projeção
    limit	Número máximo de documentos a serem recuperados da coleção
    projectionType	O tipo de projeção, seja include ou exclude
    sort	A ordem de classificação da resposta desta atividade
    key	Insira o campo a ser classificado
    value	Especifique se os documentos contendo o campo são classificados em ordem crescente (1) ou decrescente (-1)
    aggregrate	Nó contendo as especificações de uma operação de agregação
    unwind	Insira o campo para desagregar
    match	Nó contendo o par chave-valor das condições para o estágio do pipeline de correspondência
    key	Insira o campo que está sendo consultado
    value	Insira o valor desejado do campo que está sendo consultado
    sortAggregrate	Nó contendo a ordem de classificação dos resultados agregados
    key	Insira o campo a ser classificado
    value	Especifique se os documentos contendo o campo são retornados em ordem crescente (1) ou decrescente (-1)
    project	Nó contendo condições para o estágio do pipeline de projeção
    exclude	Insira o campo a ser excluído na resposta
    include	Insira o campo a ser incluído na resposta
    group	Nó contendo condições para o estágio do pipeline de agrupamento
    key	Insira a chave do grupo
    value	Insira o valor do grupo
    accumulator	Insira o acumulador
    nameNewField	Insira o nome do campo que está sendo adicionado
    out	Insira a coleção para o estágio do pipeline de saída

  • Resposta:

    Campo/Nó do Esquema de Resposta	Descrição
    queryResponse	Resposta da consulta ao banco de dados
    records	Número de documentos (registros) retornados
    documents	Nó representando os documents
    document	Conteúdo do documento

• Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do 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 de Consulta 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 do 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 Conceitos básicos do conector.

As atividades de Consulta do MongoDB podem ser usadas como fonte com esses padrões de operação:

• Padrão de transformação
• Padrão de arquivo com dois destinos (apenas como a primeira fonte)
• Padrão de arquivo HTTP com dois destinos (apenas como a primeira fonte)
• Padrão de duas transformações (como a primeira ou segunda fonte)

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.