Filter: StringFilter

Filter type for String.

All fields in this type are and-combined; see the or field for or-combination.

Input Fields

NameTypeDescription
ANDStringFilter

A field that checks if all filters in the list apply

If the list is empty, this filter applies to all objects.

ORStringFilter

A field that checks if any of the filters in the list apply.

If the list is empty, this filter applies to no objects.

Note that only the items in the list or-combined; this complete OR field is and-combined with outer fields in the parent filter type.

containsString

Checks if the value contains a specified string, case-sensitively.

ends_withString

Checks if the value ends with a specified string, case-sensitively.

equalString

Checks if the value equals a specified string, case-sensitively.

If an index exists on the value, it can be used.

See also like for a case-insensitive filter.

gtString

Checks if the value is greater than a specified value.

gteString

Checks if the value is greater or equal a specified value.

inString

Checks if the value is equal to one of the specified values.

likeString

Matches the value against a pattern case-insensitively with the following placeholders:

% matches any sequence of characters, including the empty string; _ matches exactly one character; \ can be used to escape the placeholders (use \\ for a literal backslash);

If an index exists on the value, it can be used for the literal prefix (the part until the first placeholder).

ltString

Checks if the value is less than a specified value.

lteString

Checks if the value is less or equal a specified value.

notString

Checks if the value does not equal a specified string, case-sensitively.

not_containsString

Checks if the value does not contain a specified string, case-sensitively.

not_ends_withString

Checks if the value does not end with a specified string, case-sensitively.

not_inString

Checks if the value is not equal to one of the specified values.

not_likeString

Checks if the value does not match a pattern case-insensitively with the following placeholders:

% matches any sequence of characters, including the empty string; _ matches exactly one character; \ can be used to escape the placeholders (use \\ for a literal backslash);

not_starts_withString

Checks if the value does not start with a specified string, case-sensitively.

Never uses an index. Consider using not_like (with the % placeholder) for a case-insensitive filter that can use an index.

starts_withString

Checks if the value starts with a specified string, case-sensitively.

Never uses an index. Consider using like (with the % placeholder) for a case-insensitive filter that can use an index.


This page was generated: 2024-05-17