Operator

Enumeration of query operators used for building database query conditions.

Each operator defines a specific type of comparison or logical operation that can be applied to fields in database queries. Operators range from simple equality checks to complex date range queries and array operations.

Entries

Link copied to clipboard

Logical AND operator. Combines multiple conditions where all must be true.

Link copied to clipboard

Logical OR operator. Combines multiple conditions where at least one must be true.

Link copied to clipboard

Logical NOR operator. Combines multiple conditions where none must be true.

Link copied to clipboard

ID equality operator. Matches documents where the 'id' field equals the specified value.

Link copied to clipboard

ID list operator. Matches documents where the 'id' field equals any value in the specified list.

Link copied to clipboard

Aggregate ID equality operator. Matches documents where the aggregate root ID equals the specified value.

Link copied to clipboard

Aggregate ID list operator. Matches documents where the aggregate root ID equals any value in the specified list.

Link copied to clipboard

Tenant ID equality operator. Matches documents where the 'tenantId' field equals the specified value.

Link copied to clipboard

Owner ID equality operator. Matches documents where the 'ownerId' field equals the specified value.

Link copied to clipboard

Deletion state operator. Matches documents where the 'deleted' field equals the specified value.

Link copied to clipboard

Match all operator. Matches all documents without any filtering.

Link copied to clipboard

Equality operator. Matches documents where the specified field equals the given value.

Link copied to clipboard

Not-equal operator. Matches documents where the specified field does not equal the given value.

Link copied to clipboard

Greater-than operator. Matches documents where the specified field is greater than the given value.

Link copied to clipboard

Less-than operator. Matches documents where the specified field is less than the given value.

Link copied to clipboard

Greater-than-or-equal operator. Matches documents where the specified field is greater than or equal to the given value.

Link copied to clipboard

Less-than-or-equal operator. Matches documents where the specified field is less than or equal to the given value.

Link copied to clipboard

Contains operator. Matches documents where the specified field contains the given substring.

Link copied to clipboard

In operator. Matches documents where the specified field equals any value in the given list.

Link copied to clipboard

Not-in operator. Matches documents where the specified field does not equal any value in the given list.

Link copied to clipboard

Between operator. Matches documents where the specified field falls within the given range (inclusive).

Link copied to clipboard

All-in operator. Matches documents where the specified array field contains all of the given values.

Link copied to clipboard

Starts-with operator. Matches documents where the specified field starts with the given prefix.

Link copied to clipboard

Ends-with operator. Matches documents where the specified field ends with the given suffix.

Link copied to clipboard

Element match operator. Matches documents where at least one element in the specified array field matches the given condition.

Link copied to clipboard

Null check operator. Matches documents where the specified field is null.

Link copied to clipboard

Not-null check operator. Matches documents where the specified field is not null.

Link copied to clipboard

Boolean true operator. Matches documents where the specified field is true.

Link copied to clipboard

Boolean false operator. Matches documents where the specified field is false.

Link copied to clipboard

Field existence operator. Matches documents based on whether the specified field exists.

Link copied to clipboard

Today operator. Matches documents where the date field falls within today's date range. Example: If today is 2024-06-06, matches range 2024-06-06 00:00:00.000 to 2024-06-06 23:59:59.999.

Link copied to clipboard

Before today operator. Matches documents where the date field is before the specified time today.

Link copied to clipboard

Tomorrow operator. Matches documents where the date field falls within tomorrow's date range. Example: If today is 2024-06-06, matches range 2024-06-07 00:00:00.000 to 2024-06-07 23:59:59.999.

Link copied to clipboard

This week operator. Matches documents where the date field falls within the current week's date range.

Link copied to clipboard

Next week operator. Matches documents where the date field falls within next week's date range.

Link copied to clipboard

Last week operator. Matches documents where the date field falls within last week's date range.

Link copied to clipboard

This month operator. Matches documents where the date field falls within the current month's date range. Example: If today is 2024-06-06, matches range 2024-06-01 00:00:00.000 to 2024-06-30 23:59:59.999.

Link copied to clipboard

Last month operator. Matches documents where the date field falls within last month's date range. Example: If today is 2024-06-06, matches range 2024-05-01 00:00:00.000 to 2024-05-31 23:59:59.999.

Link copied to clipboard

Recent days operator. Matches documents where the date field falls within the last N days (including today). Example: For 3 recent days, if today is 2024-06-06, matches from 2024-06-04 00:00:00.000 onwards.

Link copied to clipboard

Earlier days operator. Matches documents where the date field is earlier than N days ago. Example: For 3 days ago, if today is 2024-06-06, matches anything before 2024-06-04 00:00:00.000.

Link copied to clipboard

Raw operator. Uses the condition value directly as a raw database query condition without any processing.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun valueOf(value: String): Operator

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.