mongodb

Type:

Available in: Cloud, Self-Managed

Use a MongoDB instance as a cache.

  • Common

  • Advanced

# Common config fields, showing default values
label: ""
mongodb:
  url: mongodb://localhost:27017 # No default (required)
  database: "" # No default (required)
  username: ""
  password: ""
  collection: "" # No default (required)
  key_field: "" # No default (required)
  value_field: "" # No default (required)
# All config fields, showing default values
label: ""
mongodb:
  url: mongodb://localhost:27017 # No default (required)
  database: "" # No default (required)
  username: ""
  password: ""
  app_name: benthos
  collection: "" # No default (required)
  key_field: "" # No default (required)
  value_field: "" # No default (required)

Fields

app_name

The client application name.

Type: string

Default: benthos

collection

The name of the target collection.

Type: string

database

The name of the target MongoDB database.

Type: string

key_field

The field in the document that is used as the key.

Type: string

password

The password to connect to the database.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration.

Type: string

Default: ""

url

The URL of the target MongoDB server.

Type: string

# Examples:
url: mongodb://localhost:27017

username

The username to connect to the database.

Type: string

Default: ""

value_field

The field in the document that is used as the value.

Type: string