mongodb
Type:
Executes a query and creates a message for each document received.
Introduced in version 3.64.0.
-
Common
-
Advanced
# Common config fields, showing default values
input:
label: ""
mongodb:
url: mongodb://localhost:27017 # No default (required)
database: "" # No default (required)
username: ""
password: ""
collection: "" # No default (required)
query: |2 # No default (required)
root.from = {"$lte": timestamp_unix()}
root.to = {"$gte": timestamp_unix()}
auto_replay_nacks: true
batch_size: 1000 # No default (optional)
sort: {} # No default (optional)
limit: 0 # No default (optional)
# All config fields, showing default values
input:
label: ""
mongodb:
url: mongodb://localhost:27017 # No default (required)
database: "" # No default (required)
username: ""
password: ""
collection: "" # No default (required)
operation: find
json_marshal_mode: canonical
query: |2 # No default (required)
root.from = {"$lte": timestamp_unix()}
root.to = {"$gte": timestamp_unix()}
auto_replay_nacks: true
batch_size: 1000 # No default (optional)
sort: {} # No default (optional)
limit: 0 # No default (optional)
Once the documents from the query are exhausted, this input shuts down, allowing the pipeline to gracefully terminate (or the next input in a sequence to execute).
Fields
password
The password to connect to the database.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
operation
The mongodb operation to perform.
Type: string
Default: "find"
Requires version 4.2.0 or newer
Options:
find
, aggregate
.
json_marshal_mode
The json_marshal_mode setting is optional and controls the format of the output message.
Type: string
Default: "canonical"
Requires version 4.7.0 or newer
Option | Summary |
---|---|
|
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. |
|
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. |
query
Bloblang expression describing MongoDB query.
Type: string
# Examples
query: |2
root.from = {"$lte": timestamp_unix()}
root.to = {"$gte": timestamp_unix()}
auto_replay_nacks
Whether messages that are rejected (nacked) at the output level should be automatically replayed indefinitely, eventually resulting in back pressure if the cause of the rejections is persistent. If set to false
these messages will instead be deleted. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data can be discarded immediately upon consumption and mutation.
Type: bool
Default: true
batch_size
A explicit number of documents to batch up before flushing them for processing. Must be greater than 0
. Operations: find
, aggregate
Type: int
Requires version 4.26.0 or newer
# Examples
batch_size: 1000