> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a background Database mutation

> Explicit Operations admission for filtered UPDATE/DELETE, reviewed view mutations, and TRUNCATE. Poll Operations for durable counters. Retry resumes remaining records; committed batches are never replayed. System notifications are enabled unless skipNotification is true. Existing synchronous mutation routes retain their contract.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/databases/operations
openapi: 3.0.0
info:
  title: RevoEngine Platform API
  description: Official RevoEngine Platform API documentation.
  version: 1.6.4
  contact:
    name: Support
    email: support@revoengine.com
  termsOfService: https://docs.revoengine.com/tos
servers:
  - url: https://api.revoengine.com
    description: Production
security: []
tags:
  - name: Accounts
    description: Users, service accounts, API keys, status, and platform access.
    externalDocs:
      description: Identity and access guide
      url: https://docs.revoengine.com/operate/identity-and-access
  - name: Activity
    description: Snapshot-backed activity and version history.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Agent Memory
    description: Administrative access to durable Agent memory.
    externalDocs:
      description: Agent memory and workspaces guide
      url: https://docs.revoengine.com/ai/memory-and-workspaces
  - name: Agent Plugins
    description: Agent plugin definitions, synchronization, testing, and lifecycle.
    externalDocs:
      description: Agent plugins guide
      url: https://docs.revoengine.com/ai/plugins
  - name: Agent Terminals
    description: Terminal pairing, owner grants, access, and command activity.
    externalDocs:
      description: Connect a terminal guide
      url: https://docs.revoengine.com/ai/terminals
  - name: Agents
    description: >-
      Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and
      lifecycle.
    externalDocs:
      description: Autonomous Agents guide
      url: https://docs.revoengine.com/ai/agents
  - name: Assistant
    description: >-
      Assistant threads, messages, responses, goals, reports, sharing,
      attachments, and control.
    externalDocs:
      description: Assistant guide
      url: https://docs.revoengine.com/ai/assistant
  - name: Automation
    description: >-
      Jobs, templates, schedules, events, webhooks, execution history, and
      lifecycle.
    externalDocs:
      description: Automation guide
      url: https://docs.revoengine.com/operate/automation
  - name: Chat
    description: Collaborative chat threads, messages, reactions, uploads, and attachments.
    externalDocs:
      description: Team Chat guide
      url: https://docs.revoengine.com/operate/chat
  - name: Component deployments
    description: >-
      Custom Node.js runtime deployment attempts, readiness, activation, and
      rollback.
    externalDocs:
      description: Custom Node.js guide
      url: https://docs.revoengine.com/build/custom-nodejs
  - name: Components
    description: Components, elements, versions, validation, activation, and lifecycle.
    externalDocs:
      description: Components guide
      url: https://docs.revoengine.com/build/components
  - name: Config
    description: Instance configuration, usage, logs, and cache administration.
    externalDocs:
      description: Instance settings guide
      url: https://docs.revoengine.com/platform/instance-settings
  - name: Database Cache
    description: Instance Database cache values and statistics.
    externalDocs:
      description: Database Cache guide
      url: https://docs.revoengine.com/operate/database-cache
  - name: Database Views
    description: Database Views, previews, refreshes, exports, and controlled data actions.
    externalDocs:
      description: Database Views guide
      url: https://docs.revoengine.com/operate/database-views
  - name: Databases
    description: Database definitions, data, audits, exports, cloning, and lifecycle.
    externalDocs:
      description: Databases guide
      url: https://docs.revoengine.com/operate/databases
  - name: Endpoints
    description: >-
      Endpoint definitions, activation, validation, generated OpenAPI, and
      statistics.
    externalDocs:
      description: Endpoints guide
      url: https://docs.revoengine.com/operate/endpoints
  - name: Files
    description: Compatibility file listing, preview, download, and deletion operations.
    externalDocs:
      description: Files compatibility guide
      url: https://docs.revoengine.com/operate/files
  - name: Groups
    description: Groups, membership, avatars, and lifecycle.
    externalDocs:
      description: Groups guide
      url: https://docs.revoengine.com/operate/groups
  - name: Instance Vault
    description: Operations in the Instance Vault Platform API domain.
    externalDocs:
      description: Secrets and Vault guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Me
    description: Current user profile, keys, avatar, and session information.
    externalDocs:
      description: Authentication guide
      url: https://docs.revoengine.com/developers/authentication
  - name: Observability
    description: Authorized execution, performance, graph, and log evidence.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Preferences
    description: User and instance preference values.
    externalDocs:
      description: Platform UI guide
      url: https://docs.revoengine.com/platform/ui-tour
  - name: Role Groups
    description: Role groups, members, assigned roles, and lifecycle.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Roles
    description: Available platform roles and role details.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Search
    description: Cross-domain search over objects visible to the caller.
    externalDocs:
      description: Search and discovery guide
      url: https://docs.revoengine.com/platform/search
  - name: Secrets
    description: >-
      Secret definitions, revision history, explicit rotation, activation,
      reveal, disable, and destruction.
    externalDocs:
      description: Secrets guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Share
    description: >-
      Short-lived authenticated links to supported application routes and grid
      state.
    externalDocs:
      description: Platform API share-link guide
      url: >-
        https://docs.revoengine.com/developers/platform-api#share-application-context
  - name: Storage
    description: >-
      Storage workspaces, folders, objects, upload sessions, signed access, and
      lifecycle.
    externalDocs:
      description: Storage guide
      url: https://docs.revoengine.com/operate/storage
externalDocs:
  description: Documentation
  url: https://docs.revoengine.com
paths:
  /api/v1/databases/operations:
    post:
      tags:
        - Databases
      summary: Start a background Database mutation
      description: >-
        Explicit Operations admission for filtered UPDATE/DELETE, reviewed view
        mutations, and TRUNCATE. Poll Operations for durable counters. Retry
        resumes remaining records; committed batches are never replayed. System
        notifications are enabled unless skipNotification is true. Existing
        synchronous mutation routes retain their contract.
      operationId: DatabaseController_startDatabaseOperation
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseOperationRequestDto'
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseOperationAcceptedDto'
      security:
        - bearer: []
components:
  schemas:
    DatabaseOperationRequestDto:
      type: object
      properties:
        databaseName:
          type: string
          description: Database ID/name, or view ID when viewAction is provided.
        action:
          type: string
          enum:
            - UPDATE
            - DELETE
            - TRUNCATE
        request:
          description: >-
            Filtered selection. Returning rows is not supported in background
            operations.
          allOf:
            - $ref: '#/components/schemas/DeleteDatabaseRequestDto'
        data:
          oneOf:
            - type: object
              additionalProperties: true
            - type: array
              minItems: 1
              maxItems: 100
              items:
                type: object
                required:
                  - column
                  - op
                additionalProperties: false
                properties:
                  column:
                    type: string
                  op:
                    type: string
                    enum:
                      - set
                      - setNull
                      - add
                      - subtract
                      - multiply
                      - divide
                      - abs
                      - floor
                      - ceil
                      - sqrt
                      - round
                      - pow
                      - toggle
                      - addInterval
                      - subtractInterval
                      - truncate
                      - prepend
                      - append
                      - insert
                      - replace
                      - trim
                      - lower
                      - upper
                      - mergeJson
                      - setJsonPath
                      - removeJsonPath
                      - addItems
                      - removeItems
                  value:
                    nullable: true
                  position:
                    type: integer
                    minimum: 1
                  search:
                    type: string
                  path:
                    type: array
                    items:
                      type: string
                  create:
                    type: boolean
                  unit:
                    type: string
                  nulls:
                    type: string
                    enum:
                      - preserve
                      - empty
        viewAction:
          description: Reviewed view mutation. The preview token is validated at admission.
          allOf:
            - $ref: '#/components/schemas/DatabaseViewActionExecuteDto'
        restartIdentity:
          type: boolean
          default: false
        skipNotification:
          type: boolean
          default: false
          description: >-
            Suppress the terminal System message. Low-code defaults this to
            true.
        idempotencyKey:
          type: string
          format: uuid
          description: >-
            Actor-scoped admission key. Reusing it with a different request is
            rejected.
      required:
        - databaseName
        - action
    DatabaseOperationAcceptedDto:
      type: object
      properties:
        accepted:
          type: boolean
        jobId:
          type: string
          format: uuid
        status:
          type: string
      required:
        - accepted
        - jobId
        - status
    DeleteDatabaseRequestDto:
      type: object
      properties:
        filter:
          type: object
          description: Filter object or array of filter objects.
        join:
          type: object
          description: Join definition for filtering.
        take:
          type: number
          description: Limit of affected rows.
          minimum: 1
        skip:
          type: number
          description: Offset of affected rows.
        return:
          type: boolean
          description: Return updated rows.
        onlyKeys:
          type: boolean
          description: Return only primary keys (reduces payload).
      required:
        - filter
    DatabaseViewActionExecuteDto:
      type: object
      properties:
        action:
          type: string
          enum:
            - UPDATE
            - DELETE
        targetDatabaseId:
          type: string
        keyMapping:
          type: object
        mutationToken:
          type: string
        data:
          oneOf:
            - type: object
              additionalProperties: true
            - type: array
              minItems: 1
              maxItems: 100
              items:
                type: object
                required:
                  - column
                  - op
                additionalProperties: false
                properties:
                  column:
                    type: string
                  op:
                    type: string
                    enum:
                      - set
                      - setNull
                      - add
                      - subtract
                      - multiply
                      - divide
                      - abs
                      - floor
                      - ceil
                      - sqrt
                      - round
                      - pow
                      - toggle
                      - addInterval
                      - subtractInterval
                      - truncate
                      - prepend
                      - append
                      - insert
                      - replace
                      - trim
                      - lower
                      - upper
                      - mergeJson
                      - setJsonPath
                      - removeJsonPath
                      - addItems
                      - removeItems
                  value:
                    nullable: true
                  position:
                    type: integer
                    minimum: 1
                  search:
                    type: string
                  path:
                    type: array
                    items:
                      type: string
                  create:
                    type: boolean
                  unit:
                    type: string
                  nulls:
                    type: string
                    enum:
                      - preserve
                      - empty
        return:
          type: boolean
        onlyKeys:
          type: boolean
      required:
        - action
        - targetDatabaseId
        - keyMapping
        - mutationToken
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      description: Bearer JWT token or API Key (sk-*).
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.