​
Authentication

This provider requires authentication.

  • host: Mongo host_uri (required: True, sensitive: False)
  • username: MongoDB username (required: False, sensitive: False)
  • password: MongoDB password (required: False, sensitive: True)
  • database: MongoDB database name (required: False, sensitive: False)
  • auth_source: Mongo authSource database name (required: False, sensitive: False)
  • additional_options: Mongo kwargs, these will be passed to MongoClient (required: False, sensitive: False)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

  • connect_to_server: The user can connect to the server (mandatory)

​
In workflows

This provider can be used in workflows.

As “step” to query data, example:

steps:
    - name: Query mongodb
      provider: mongodb
      config: "{{ provider.my_provider_name }}"
      with:
        query: {value}  
        as_dict: {value}  
        single_row: {value}

Check the following workflow example:

​
Connecting with the Provider

In order to connect to the MongoDB database, you can use either a connection URI or individual parameters. Here’s how you can provide authentication information:

  1. If using a connection URI, provide the host parameter with the MongoDB connection string.
  2. If using individual parameters, provide the following:
    • username: MongoDB username.
    • password: MongoDB password.
    • host: MongoDB hostname.
    • database: MongoDB database name.
    • authSource: MongoDB database name.

​
Notes

  • Ensure that the provided user has the necessary privileges to execute queries on the specified MongoDB database.