must

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

Connection Type

This block connects from a query type block. Make sure to connect this block to the appropriate left-hand side connection.

must v10.4.28

All queries provided must match.

In pins 1
  • query required
    query
Out pins 1
  • query
    query

Collects every wired query input into a bool.must clause: {"bool": {"must": [...]}} : every clause must match and each contributes to relevance scoring. Arrays are flattened in; control fragments (fields, limit, offset, sort, count, ...) are hoisted to the top level of the output instead of being nested as clauses. With nothing wired the output is {"bool": {}}, which matches everything.

must wraps one or more term queries: documents only match when every wrapped query does. The term comes from fields with a fixed value here, and the combined query feeds search single.

Studio canvas example for the must block: requiring a term in a search query.

Commonly used with

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

  • fields: feeds into this block.
  • search: this block feeds into it. searches in the given storage based on a query.
  • multiple: this block feeds into it.
  • match with any: feeds into this block.
  • search single: this block feeds into it. searches in the given storage based on a query and returns maximum one result.
  • date: feeds into this block. do range checks on date fields.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v10.4.28.


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