query string

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.

Parent Requirements

This block requires specific parent elements: query_bool_must, query_bool_must_not, query_bool_filter, query_bool_should, query_first_defined. Ensure this block is placed within the appropriate parent context.

query string v10.4.28

In pins 4
  • fields required
    fielddefinitions
  • search required
    value
  • operator (OR)
    value
  • Boost
    number

    Default 1.0

Out pins 1
  • query
    query

Emits a query_string full-text clause over the selected fields; the search pin supports full Lucene syntax (wildcards, AND/OR, field scoping), and malformed syntax fails the whole search : for raw user input use simple query string instead. Fields are read from the fielddefinitions pin (entries without a non-empty field string are dropped); search defaults to "" and boost to 1. default_operator is "OR" unless the or pin holds a truthy value, which is then stringified into the operator.

A typical wiring for query string: the query out pin feeds cast to object.

Studio canvas example for the query string block: typical wiring for query string.

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