DocsWorkflowsComponentsAppapp:record:bulk:delete

app:record:bulk:delete

Soft-deletes a set of records in one write and returns the identifiers the write reached

Options

NameTypeDescription
schemastringThe name of the schema (database) that contains the table
tablestringThe name of the table that contains the records
ids[]stringThe identifiers of the records to soft-delete

Outputs

NameTypeDescription
ids[]stringThe identifiers of the records the delete reached, which is never an echo of what the step named. A record already deleted, or one the run's own envelope keeps out of reach, is absent
countintThe number of records deleted

Example

name: Delete several records at once
actions:
  - name: deleted
    component: app:record:bulk:delete
    vars:
      schema: content
      table: articles
      ids: "{{ expired.ids }}"

outputs:
  count: "{{ deleted.count }}"