Filter: StringFilter

Filter type for String.

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

Input Fields

Name	Type	Description
AND	StringFilter	A field that checks if all filters in the list apply If the list is empty, this filter applies to all objects.
OR	StringFilter	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.
contains	String	Checks if the value contains a specified string, case-sensitively.
ends_with	String	Checks if the value ends with a specified string, case-sensitively.
equal	String	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.
gt	String	Checks if the value is greater than a specified value.
gte	String	Checks if the value is greater or equal a specified value.
in	String	Checks if the value is equal to one of the specified values.
like	String	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).
lt	String	Checks if the value is less than a specified value.
lte	String	Checks if the value is less or equal a specified value.
not	String	Checks if the value does not equal a specified string, case-sensitively.
not_contains	String	Checks if the value does not contain a specified string, case-sensitively.
not_ends_with	String	Checks if the value does not end with a specified string, case-sensitively.
not_in	String	Checks if the value is not equal to one of the specified values.
not_like	String	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_with	String	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_with	String	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