get multiple documents (cached)

This block is part of the storage group and was last modified in core v15.0.0.

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.

get multiple documents (cached) v15.0.0

Get multiple documents from the given storage using the hot document cache. Fetches each document individually. Skips documents that do not exist or are removed.

In pins 3 + flow
  • flow
    flow
  • storage required
    storage
  • guids required
    array

    Array of guids (values), or Array of Objects with _meta

  • include removed required
    condition

    Default false

Out pins 3 + flow
  • flow
    flow
  • documents
    array
  • all found v15.0.0
    condition

    True only when every requested guid resolved to a document with no store error : missing, removed-and-hidden, or failed reads all make it false. Gate on this (or on error) when an incomplete result must fail closed, e.g. enforcement checks.

  • error v15.0.0
    value

    First store failure encountered (empty when none). A document that simply does not exist is a skip, not an error : this pin fires on real storage failures, so an outage is distinguishable from an empty result.

Fetches each requested guid individually via the hot document cache and outputs the found documents, skipping misses: duplicate guids are deduped and objects with _meta.guid are accepted in place of plain guid strings. Removed documents are skipped unless include_removed is true. all_found is true only when every guid resolved cleanly : a missing, removed-and-hidden, or errored document makes it false : and error carries the first real store failure (a simple miss is a skip, not an error).

A typical wiring for get multiple documents (cached): range feeds the flow pin; select field values feeds the guids pin; the flow out pin feeds reply in JSON; the documents out pin feeds select field values.

Studio canvas example for the get multiple documents (cached) block: typical wiring for get multiple documents (cached).

Commonly used with

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

  • select field values: wired in both directions with this block. returns an array with values of the given field in this array of objects.
  • get multiple documents (cached): wired in both directions with this block. Get multiple documents from the given storage using the hot document cache. Fetches each document individually. Skips documents that do not exist or are removed.
  • range: feeds into this block. get a range of elements from a list. Use start 0 and stop -1 to retrieve all items.
  • reply in JSON: this block feeds into it. Reply to any httpconnection as JSON body.
  • map: this block feeds into it. Creates a new array with the results of the provided function on every element in the array.
  • execute: this block feeds into it. Executes the given funcion and waits for it to be executed.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v15.0.0.


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