search streaming

This block is part of the storage group and was last modified in core v10.4.28.

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.

search streaming v10.4.28

streams the results of the search to a function. When using a limit, the first scroll will always fetch 10k items, we'll just truncate them if your limit is < 10k.

In pins 4 + flow
  • flow
    flow
  • Query required
    query

    Search will return cached results by default. Turn this behaviour off by adding Disable cache to this query. • Suggestions: query_bool_must query_bool_must_not query_bool_should

  • Concurrency
    number
  • ID
    value
  • Storage required
    storage
Out pins 2 + flow
  • flow
    flow
  • count
    number
  • Each result
    execute_function

Runs the query against the storage and executes the wired function once per result, with index and result pins. Result sets under 2000 items (or with a limit under 3000) are delivered in one search; larger ones stream through a scroll cursor, so memory stays bounded by the page rather than the result set. Searches every storage named on the storage pin. Outputs count = the number of items actually streamed to the function, capped by the query's limit. Missing storage or a failed search outputs count=0 and does not run the function.

iterator
streaming

A typical wiring for search streaming: a function trigger starts the flow; fields feeds the query pin; selector feeds the storage pin; the function out pin wires to an execute block.

Studio canvas example for the search streaming block: typical wiring for search streaming.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v10.4.28.


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