Update or replace one or many documents in a MongoDB collection.

yaml
type: "io.kestra.plugin.mongodb.update"

Examples

Replace a document.

yaml
id: mongodb_update
namespace: company.team

tasks:
  - id: update
    type: io.kestra.plugin.mongodb.Update
    connection:
      uri: "mongodb://root:example@localhost:27017/?authSource=admin"
    database: "my_database"
    collection: "my_collection"
    operation: "REPLACE_ONE"
    document:
      _id:
        $oid: 60930c39a982931c20ef6cd6
      name: "John Doe"
      city: "Paris"
    filter:
      _id:
        $oid: 60930c39a982931c20ef6cd6

Update a document.

yaml
id: mongodb_update
namespace: company.team

tasks:
  - id: update
    type: io.kestra.plugin.mongodb.Update
    connection:
      uri: "mongodb://root:example@localhost:27017/?authSource=admin"
    database: "my_database"
    collection: "my_collection"
    filter:
      _id:
        $oid: 60930c39a982931c20ef6cd6
    document: "{"$set": { "tags": ["blue", "green", "red"]}}"

Properties

collection *string

MongoDB collection.

connection *MongoDbConnection

MongoDB connection properties.

database *string

MongoDB database.

document *object

MongoDB document

Can be a BSON string or a map.

filter *object

MongoDB BSON filter

Can be a BSON string or a map.

operation string

Default UPDATE_ONE

Possible Values

REPLACE_ONEUPDATE_ONEUPDATE_MANY

Operation to use

Outputs

matchedCount integer

Default 0

The number of documents matched by the query

modifiedCount integer

The number of documents modified by the update

upsertedId string

The upserted ID

Will be null for replace operation.

wasAcknowledged boolean

Whether the write was acknowledged

Metrics

updated.count counter

Unit count

Number of documents updated in MongoDB

Definitions

io.kestra.plugin.mongodb.MongoDbConnection

uri *string

Connection string to MongoDB server

URL format like mongodb://mongodb0.example.com: 27017