MongoDB Collection

Reads, writes, or upserts documents in a MongoDB collection, depending on operation.

Configuration

- mongodb_collection:
    name: read_customers
    operation: read
    credentials_path: /etc/mongodb/credentials.json
    db_name: sales
    collection_name: customers
    filter:
      status: "active"

Fields

Examples

Read with a filter:

- mongodb_collection:
    name: read_customers
    operation: read
    credentials_path: /etc/mongodb/credentials.json
    db_name: sales
    collection_name: customers
    filter:
      status: "active"

Write the incoming event as a document:

- mongodb_collection:
    name: write_customer
    operation: write
    credentials_path: /etc/mongodb/credentials.json
    db_name: sales
    collection_name: customers

Upsert the first document matching filter:

- mongodb_collection:
    name: upsert_customers
    operation: upsert
    credentials_path: /etc/mongodb/credentials.json
    db_name: sales
    collection_name: customers
    filter:
      email: "[email protected]"

The incoming event is the update. A plain document is wrapped in $set:

{ "name": "Ada Lovelace", "status": "active" }

A document whose top-level keys are all update operators is applied as written:

{ "$inc": { "visits": 1 } }

The two forms cannot be mixed, and an empty payload is rejected. filter is required — without one every document matches, and the update would hit an arbitrary one instead of inserting.

If nothing matches, the document is inserted. An _id in the payload applies only to that insert, never overwriting the _id of a matched document, and must be written as { "$oid": "..." } — the same shape write accepts.

Filters

filter is a MongoDB query document. Values keep their YAML types and any query operator works:

filter:
  age: { "$gt": 30 }
  status: { "$in": ["active", "trial"] }
  archived: false

A bare value means equality, and count: 5 matches the number 5 rather than the string "5".

See Credentials for the credentials file format.

Output