Pular para o conteúdo principal

MongoDB

Visão Geral​

O componente MongoDB realiza operações de leitura e escrita em coleções de uma base de dados MongoDB.

Configuração​

Aqui estão os parâmetros gerais para a configuração do componente. Todos os parâmetros de campos de texto aceitam o uso de variáveis. Parâmetros que suportam expressões de template estão marcados com (Tmpl).

Informação adicional

O uso de variáveis em parâmetros de campos de texto é feito utilizando a expressão {{var.nome_da_variavel}}. Para saber mais sobre o uso de variáveis na criação de integrações, acesse a seção Canvas de integrações.

Alguns parâmetros suportam expressões de template para utilização de valores dinâmicos. Para saber mais sobre o funcionamento dessa linguagem e como utilizar expressões de template para referenciar dados para valores dinâmicos, acesse a seção Go Template de integrações.

Parâmetros​

  • ID do Componente: Obrigatório. Identificador do componente no fluxo de integração.
Informação adicional

Os IDs são únicos por fluxo. Não é possível ter mais de um componente com o mesmo ID.

O ID do Componente não pode conter espaços, deve iniciar com número e pode conter apenas letras sem acentos, números e o caractere _.

  • Nome: Rótulo opcional para identificar o componente visualmente no canvas.
  • Secret de autenticação: Secret do tipo Autenticação (usuário e senha) para conexão com o banco. Opcional caso não haja autenticação. Para saber mais sobre secrets, acesse a seção Secrets da Administração do iPaaS.
  • Endereço: Obrigatório.
  • Porta: Obrigatório.
  • Banco de dados: Obrigatório. Nome da base de dados.
  • Coleção: Obrigatório. Nome da coleção de documentos a ser manipulada.
  • Operação: Obrigatório. Operação a ser executada. Opções: InsertOne, UpdateOne, FindOne, Find, DeleteOne, DeleteMany
  • Documento (Tmpl): Obrigatório. Documento a ser armazenado na coleção. Disponível somente se a operação for InsertOne ou UpdateOne. O conteúdo deve ser um JSON válido.
  • Filtro (Tmpl): Obrigatório. Objeto JSON correspondente aos filtros de busca para a operação a ser executada. Disponível para as operações UpdateOne, FindOne, Find, DeleteOne, DeleteMany. O conteúdo deve ser um JSON válido.

Saída​

Após a execução do componente, uma estrutura chave-valor será gerada com os dados de saída. Os dados podem ser acessados pelo contexto de execução em outros componentes em etapas posteriores do fluxo a partir da sintaxe .id_do_componenteOut.atributo_da_estrutura, onde:

  • id_do_componente: valor configurado do parâmetro ID do Componente
  • Out: sufixo padrão obrigatório
  • atributo_da_estrutura: atributo retornado na estrutura chave-valor de saída da execução do componente
Atenção!

Caso ocorra algum erro durante a execução do componente, a estrutura chave-valor de saída não é gerada.

Aqui estão os atributos gerais da estrutura de saída do componente:

  • InsertedID: Campo _id (ObjectId) do documento. Disponível para a operação InsertOne.
  • UpsertedID: Campo _id (ObjectId) do documento inserido, ou nulo se não tiver sido efetuada qualquer inserção. Disponível para a operação UpdateOne.
  • MatchedCount: Quantidade de documentos correspondentes ao filtro. Disponível para a operação UpdateOne.
  • ModifiedCount: Quantidade de documentos modificados na operação. Disponível para a operação UpdateOne.
  • UpsertedCount: Quantidade de documentos atualizados na operação. Disponível para a operação UpdateOne.
  • DeletedCount: Quantidade de documentos apagados. Disponível para as operações DeleteOne, DeleteMany
  • Para a operação FindOne, caso existam documentos correspondentes ao filtro, o documento será retornado diretamente na estrutura de saída.
  • Para a operação Find, caso existam documentos correspondentes ao filtro, uma lista (array) será retornada diretamente na estrutura de saída com todos os documentos correspondentes.

Exemplo - operação InsertOne:

// ID do Componente: mongoStep
{
  "mongoStepOut": {
    "InsertedID": "5f977fa54d0c6863084b4567"
  }
}

Exemplo - operação UpdateOne:

// ID do Componente: mongoStep
{
  "mongoStepOut": {
    "UpsertedID": "5f977fa54d0c6863084b4567"
    "MatchedCount": 1,
    "ModifiedCount": 1,
    "UpsertedCount": 1,
  }
}

Exemplo - operações DeleteOne, DeleteMany:

// ID do Componente: mongoStep
{
  "mongoStepOut": {
    "DeletedCount": 1
  }
}

Exemplo - operação FindOne:

// ID do Componente: mongoStep
{
  "mongoStepOut": {
    "_id": "5f977fa54d0c6863084b4567",
    "user": "John Doe",
    "email": "john.doe@dhuo.io"
  }
}

Exemplo - operação Find:

// ID do Componente: mongoStep
{
  "mongoStepOut": [
    {
      "_id": "5f977fa54d0c6863084b4567",
      "user": "John Doe",
      "email": "john.doe@dhuo.io"
    }
  ]
}