mongodb

Type:

Available in: Cloud, Self-Managed

Performs operations against MongoDB for each message, allowing you to store or retrieve data within message payloads.

  • Common

  • Advanced

# Common configuration fields, showing default values
label: ""
mongodb:
  url: mongodb://localhost:27017 # No default (required)
  database: "" # No default (required)
  username: "" # No default (optional)
  password: "" # No default (optional)
  collection: "" # No default (required)
  operation: insert-one
  write_concern:
    w: "" # No default (optional)
    j: false
    w_timeout: "" # No default (optional)
  document_map: "" # No default (optional)
  filter_map: "" # No default (optional)
  hint_map: "" # No default (optional)
  upsert: false
# All configuration fields, showing default values
label: ""
mongodb:
  url: mongodb://localhost:27017 # No default (required)
  database: "" # No default (required)
  username: "" # No default (optional)
  password: "" # No default (optional)
  app_name: benthos
  collection: "" # No default (required)
  operation: insert-one
  write_concern:
    w: "" # No default (optional)
    j: false
    w_timeout: "" # No default (optional)
  document_map: "" # No default (optional)
  filter_map: "" # No default (optional)
  hint_map: "" # No default (optional)
  upsert: false
  json_marshal_mode: canonical

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

document_map

A Bloblang map that represents a document to store in MongoDB, expressed as extended JSON in canonical form. The document_map parameter is required for the following database operations: insert-one, replace-one, update-one, and aggregate.

Type: string

Default: ""

# Examples:
document_map: |-
  root.a = this.foo
  root.b = this.bar

filter_map

A Bloblang map that represents a filter for a MongoDB command, expressed as extended JSON in canonical form. The filter_map parameter is required for all database operations except insert-one.

This output uses filter_map to find documents for the specified operation. For example, for a delete-one operation, the filter map should include the fields required to locate the document for deletion.

Type: string

Default: ""

# Examples:
filter_map: |-
  root.a = this.foo
  root.b = this.bar

hint_map

A Bloblang map that represents a hint or index for a MongoDB command to use, expressed as extended JSON in canonical form. This map is optional, and is used with all operations except insert-one.

Define a hint_map to improve performance when finding documents in the MongoDB database.

Type: string

Default: ""

# Examples:
hint_map: |-
  root.a = this.foo
  root.b = this.bar

json_marshal_mode

Controls the format of the output message (optional).

Type: string

Default: canonical

Option Summary

canonical

A string format that emphasizes type preservation at the expense of readability and interoperability. That is, conversion from canonical to BSON will generally preserve type information except in certain specific cases.

relaxed

A string format that emphasizes readability and interoperability at the expense of type preservation. That is, conversion from relaxed format to BSON can lose type information.

operation

The MongoDB database operation to perform.

Type: string

Default: insert-one

Options: insert-one, delete-one, delete-many, replace-one, update-one, find-one, aggregate

password

The password required 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: ""

upsert

The upsert parameter is optional, and only applies for update-one and replace-one operations. If the filter specified in filter_map matches an existing document, this operation updates or replaces the document, otherwise a new document is created.

Type: bool

Default: false

url

The URL of the target MongoDB server.

Type: string

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

username

The username required to connect to the database.

Type: string

Default: ""

write_concern

The write concern settings for the MongoDB connection.

Type: object

write_concern.j

The j requests acknowledgement from MongoDB, which is created when write operations are written to the journal.

Type: bool

Default: false

write_concern.w

The w requests acknowledgement, which write operations propagate to the specified number of MongoDB instances.

Type: string

Default: majority

write_concern.w_timeout

The write concern timeout.

Type: string

Default: ""