Skip to content

Filters Reference ​

NameNotes
equalsExact match for the given value
equalsAnyAt least one exact match for a value of the given list
containsBefore and after wildcard search for the given value
rangeFor range compatible fields like numbers or dates
notAllows to negate a filter
multiAllows to combine different filters
prefixBefore wildcard search for the given value
suffixAfter wildcard search for the given value

Equals ​

The Equals filter allows you to check fields for an exact value. The following SQL statement is executed in the background: WHERE stock = 10.

EqualsAny ​

The EqualsAny filter allows you to filter a field where at least one of the defined values matches exactly. The following SQL statement is executed in the background: WHERE productNumber IN ('3fed029475fa4d4585f3a119886e0eb1', '77d26d011d914c3aa2c197c81241a45b').

Contains ​

The Contains Filter allows you to filter a field to an approximate value, where the passed value must be contained as a full value. The following SQL statement is executed in the background: WHERE name LIKE '%Lightweight%'.

Range ​

The Range filter allows you to filter a field to a value space. This can work with date or numerical values. Within the parameter property, the following values are possible:

  • gte => Greater than equals
  • lte => Less than equals
  • gt => Greater than
  • lt => Less than

The following SQL statement is executed in the background: WHERE stock >= 20 AND stock <= 30.

Not ​

The Not filter is a container that allows negating any filter. The operator allows you to define the combination of queries within the NOT filter (OR and AND). The following SQL statement is executed in the background: WHERE !(stock = 1 OR availableStock = 1) AND active = 1:

Multi ​

The Multi filter is a container that allows you to set logical links between filters. The operator allows you to define the links between the queries within the Multi filter (OR and AND). The following SQL statement is executed in the background: WHERE (stock = 1 OR availableStock = 1) AND active = 1.

Prefix ​

The Prefix Filter allows you to filter a field to an approximate value, where the passed value must be the start of a full value. The following SQL statement is executed in the background: WHERE name LIKE 'Lightweight%'.

Suffix ​

The Suffix Filter allows you to filter a field to an approximate value, where the passed value must be the end of a full value. The following SQL statement is executed in the background: WHERE name LIKE '%Lightweight'.

In general, storage systems are case-insensitive, meaning that when filtering for a string, the casing of the filter values doesn't affect the search.

Was this page helpful?
UnsatisfiedSatisfied
Be the first to vote!
0.0 / 5  (0 votes)