PluginsPlugin Documentdb

Delete​Delete

Delete documents from a DocumentDB collection.

Delete one or more documents from a DocumentDB collection that match the filter criteria.

yaml
type: "io.kestra.plugin.documentdb.Delete"

Delete a single user document

yaml
id: delete_documentdb_user
namespace: company.documentdb

tasks:
  - id: delete_user
    type: io.kestra.plugin.documentdb.Delete
    host: "https://my-documentdb-instance.com"
    database: "myapp"
    collection: "users"
    username: "{{ secret('DOCUMENTDB_USERNAME') }}"
    password: "{{ secret('DOCUMENTDB_PASSWORD') }}"
    filter:
      email: "[email protected]"
    deleteMany: false

Delete multiple inactive documents

yaml
id: cleanup_inactive_users
namespace: company.documentdb

tasks:
  - id: delete_inactive_users
    type: io.kestra.plugin.documentdb.Delete
    host: "https://my-documentdb-instance.com"
    database: "myapp"
    collection: "users"
    username: "{{ secret('DOCUMENTDB_USERNAME') }}"
    password: "{{ secret('DOCUMENTDB_PASSWORD') }}"
    filter:
      status: "inactive"
      last_login:
        $lt: "2022-01-01"
    deleteMany: true

Delete documents by age criteria

yaml
id: delete_old_logs
namespace: company.documentdb

tasks:
  - id: cleanup_old_logs
    type: io.kestra.plugin.documentdb.Delete
    host: "https://my-documentdb-instance.com"
    database: "logging"
    collection: "application_logs"
    username: "{{ secret('DOCUMENTDB_USERNAME') }}"
    password: "{{ secret('DOCUMENTDB_PASSWORD') }}"
    filter:
      created_at:
        $lt: "{{ now() | dateAdd(-30, 'DAYS') }}"
      level:
        $in: ["DEBUG", "INFO"]
    deleteMany: true
Properties

Collection name

The name of the collection

Database name

The name of the database

DocumentDB host

The HTTP endpoint URL of your DocumentDB instance

Password

DocumentDB password for authentication

Username

DocumentDB username for authentication

Default false

Delete multiple documents

If true, deletes all documents matching the filter (deleteMany). If false, deletes only the first match (deleteOne).

Filter criteria

MongoDB-style filter to select which documents to delete. Example: {"status": "inactive", "age": {"$gte": 18}}

Number of documents deleted

Total count of documents that were successfully deleted