Filters Reference
Name | Notes |
---|---|
equals | Exact match for the given value |
equalsAny | At least one exact match for a value of the given list |
contains | Before and after wildcard search for the given value |
range | For range compatible fields like numbers or dates |
not | Allows to negate a filter |
multi | Allows to combine different filters |
prefix | Before wildcard search for the given value |
suffix | After 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 equalslte
=> Less than equalsgt
=> Greater thanlt
=> Less than
The following SQL statement is executed in the background: WHERE stock >= 20 AND stock <= 30
.
Not
The Not
Filter is a container which allows to negate any kind of 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, which allows 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, the storage systems are case-insensitive, meaning that when filtering values to search for a string, the casing of the filter values doesn't affect their handling.