remove multiple documents

This block is part of the storage group and was last modified in core v13.0.6.

Storage Selection Required

This block relies on a storage to perform its storage releated actions. You must manually select the storage you want to use in your flow using the storage selector modal. To access the modal, click the white button on the block.

remove multiple documents v9.2.5 Updated v13.0.6

Removes multiple documents from the given storage.

In pins 4 + flow
  • flow
    flow
  • array required
    array
  • expiry
    date

    When a document is given an expiry date, the document will be unrecoverably deleted on the given date

  • update priority v13.0.6
    number

    A document update can be important for search relevance or not, by poviding the system a priority you can help it understand what updates are high priority (1) and what updates can be delayed without huge impact for search relevance (3). 1 is highest priority, 2 is medium priority, 3 is low priority and 0 is wait-for-insert.

    Default 1

  • storage required
    storage
Out pins 2 + flow
  • flow
    flow
  • success
    condition
  • error
    value

SOFT-deletes every document whose guid is in the array (plain guid strings or objects with _meta.guid); the documents stay recoverable. It stops at the FIRST failure : success=false with that error, later guids never attempted, earlier ones already removed. An empty array or any simulated run reports success=true without touching storage.

A typical wiring for remove multiple documents: search feeds the flow pin; date now feeds the expiry pin; foreach feeds the array pin; the flow out pin feeds search; the error out pin feeds update document.

Studio canvas example for the remove multiple documents block: typical wiring for remove multiple documents.

Commonly used with

In production blueprints, this block is most often wired together with:

  • search: wired in both directions with this block. searches in the given storage based on a query.
  • date now: feeds into this block. Gives you the current date based on your timezone.
  • branch: feeds into this block.
  • funnel: this block feeds into it.
  • plus months: feeds into this block. Plus an selected amount of years to your given date.
  • foreach: feeds into this block.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v9.2.5.

Last modified in v13.0.6.

Back to storage Return to the main group to view all sub-groups Back to storage Return to the group to view all blocks within this group

Was this page helpful? Tell us what to improve · RUAL Docs is an integral component of the RUAL ecosystem