Types

Link copied to clipboard

Special type used by the WithArrayFilters.arrayFilter lambda parameter to designate the current array filter.

Properties

Link copied to clipboard

The context used to generate this expression.

Link copied to clipboard

Converts a Kotlin property into a Field.

Functions

Link copied to clipboard
abstract override fun accept(node: BsonNode)

Adds a new node as a child of this one.

Link copied to clipboard

Adds any number of nodes into this one.

Link copied to clipboard

Performs a logical AND operation on one or more expressions, and selects the documents that satisfy all the expressions.

Link copied to clipboard

Specify multiple operators on fields of a single array element.

Link copied to clipboard

Specify multiple operators on a single array element.

Link copied to clipboard

Matches documents where all bit positions present in mask are clear (i.e., 0) in the current field.

Link copied to clipboard

Matches documents where all bit positions present in mask are set (i.e., 1) in the current field.

Link copied to clipboard

Matches documents where any bit position present in mask is clear (i.e., 0) in the current field.

Link copied to clipboard

Matches documents where any bit position present in mask is set (i.e., 1) in the current field.

Link copied to clipboard

Selects documents where the value of a field is an array that contains all the specified values.

Link copied to clipboard
open operator fun <Root, Parent, Child> KProperty1<Root, Parent>.div(child: KProperty1<Parent & Any, Child>): Field<Root, Child>
open operator fun <Root, Type, Child> Field<Root, Type>.div(child: KProperty1<in Type & Any, Child>): Field<Root, Child>
open operator fun <Root, Type, Child> Field<Root, Type>.div(child: Field<Type, Child>): Field<Root, Child>

Refers to child as a nested field of the current field.

Combines Kotlin properties into a path usable to point to any item in an array.

Link copied to clipboard

Matches documents that do not contain the specified field. Documents where the field if null are not matched.

Link copied to clipboard
infix inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.eq(value: V)

Matches documents where the value of a field equals the value.

Link copied to clipboard

Matches documents where the value of a field equals value.

Link copied to clipboard

Matches documents that contain the specified field, including values where the field value is null.

Link copied to clipboard

Enables the usage of aggregation values within a regular query.

Link copied to clipboard
abstract override fun freeze()

Makes this expression immutable.

Link copied to clipboard

Matches documents whose geospatial data intersects with the given geometry.

Matches documents whose geospatial data intersects with the given polygon.

Link copied to clipboard
open operator fun <Root, Type> KProperty1<Root, Collection<Type>>.get(index: Int): Field<Root, Type>
open operator fun <Root, Type> Field<Root, Collection<Type>>.get(index: Int): Field<Root, Type>

Refers to a specific item in an array, by its index.

open operator fun <Root, Type> KProperty1<Root, Map<String, Type>>.get(index: String): Field<Root, Type>
open operator fun <Root, Type> Field<Root, Map<String, Type>>.get(key: String): Field<Root, Type>

Refers to a specific item in a map, by its name.

Link copied to clipboard
infix inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.gt(value: V)

Selects documents for which this field has a value strictly greater than value.

Link copied to clipboard
infix inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.gte(value: V)

Selects documents for which this field has a value greater or equal to value.

Link copied to clipboard

Selects documents for which this field has a value greater or equal to value.

Link copied to clipboard

Selects documents for which this field has a value strictly greater than value.

Link copied to clipboard

Selects documents where the value of the field is an instance of the specified BSON type.

Link copied to clipboard
inline operator fun <V> KProperty1<ArrayFiltersOptionDsl.IteratorType<Document>, V>.invoke(noinline block: FilterQueryPredicate<V>.() -> Unit)
inline operator fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.invoke(noinline block: FilterQueryPredicate<V>.() -> Unit)

Targets a single field to execute a targeted predicate.

Link copied to clipboard

Matches documents in which an array is empty or absent.

Link copied to clipboard
@JvmName(name = "isInSimple")
infix inline fun <V : Comparable<V>, R : ClosedRange<V>, OpenEndRange<V>> KProperty1<ArrayFiltersOptionDsl.IteratorType<Document>, V?>.isIn(range: R)
@JvmName(name = "isInSimple")
infix inline fun <V : Comparable<V>, R : ClosedRange<V>, OpenEndRange<V>> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V?>.isIn(range: R)
@JvmName(name = "isInSimpleWithType")
open fun <V : Comparable<V>, R : ClosedRange<V>, OpenEndRange<V>> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V?>.isIn(range: R, type: KType)

Selects documents in which this field has a value included in range.

Link copied to clipboard

Matches documents in which a map is empty or absent.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Selects documents for which the field is not null.

Link copied to clipboard

Selects documents for which this field is not equal to any of the given values.

Link copied to clipboard

Selects documents for which the field is not undefined.

Link copied to clipboard

Selects documents for which the field is null.

Link copied to clipboard
inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.isOneOf(vararg values: V)

Selects documents for which this field is equal to one of the given values.

Link copied to clipboard

Selects documents for which the field is undefined.

Link copied to clipboard
infix inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.lt(value: V)

Selects documents for which this field has a value strictly lesser than value.

Link copied to clipboard
infix inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.lte(value: V)

Selects documents for which this field has a value lesser or equal to value.

Link copied to clipboard

Selects documents for which this field has a value lesser or equal to value.

Link copied to clipboard

Selects documents for which this field has a value strictly lesser than value.

Link copied to clipboard

Selects documents where the value of the field divided by divisor has the specified remainder.

Link copied to clipboard
infix inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.ne(value: V)

Matches documents where the value of a field does not equal the value.

Link copied to clipboard
open fun KProperty1<ArrayFiltersOptionDsl.IteratorType<Document>, Geo.Point>.near(target: Geo.Point, minDistance: Double? = null, maxDistance: Double? = null)
abstract fun Field<ArrayFiltersOptionDsl.IteratorType<Document>, Geo.Point>.near(target: Geo.Point, minDistance: Double? = null, maxDistance: Double? = null)

Matches documents where a Geo.Point is near the target.

Link copied to clipboard
open fun KProperty1<ArrayFiltersOptionDsl.IteratorType<Document>, Geo.Point>.nearSphere(target: Geo.Point, minDistance: Double? = null, maxDistance: Double? = null)
abstract fun Field<ArrayFiltersOptionDsl.IteratorType<Document>, Geo.Point>.nearSphere(target: Geo.Point, minDistance: Double? = null, maxDistance: Double? = null)

Matches documents where a Geo.Point is near the target, using spherical geometry.

Link copied to clipboard

Performs a logical NOR operation on one or more expressions, and selects the documents that do not satisfy any of the expressions.

Link copied to clipboard
infix inline fun <V> KProperty1<ArrayFiltersOptionDsl.IteratorType<Document>, V>.not(noinline expression: FilterQueryPredicate<V>.() -> Unit)
infix inline fun <V> Field<ArrayFiltersOptionDsl.IteratorType<Document>, V>.not(noinline expression: FilterQueryPredicate<V>.() -> Unit)

Performs a logical NOT operation on the specified expression and selects the documents that do not match the expression. This includes the elements that do not contain the field.

Link copied to clipboard

Performs a logical OR operation on one or more expressions, and selects the documents that satisfy at least one of the expressions.

Link copied to clipboard
open fun KProperty1<ArrayFiltersOptionDsl.IteratorType<Document>, String?>.regex(@Language(value = "JSRegexp") pattern: String, caseInsensitive: Boolean = false, dotAll: Boolean = false, extended: Boolean = false, matchEachLine: Boolean = false)
open fun Field<ArrayFiltersOptionDsl.IteratorType<Document>, String?>.regex(@Language(value = "JSRegexp") pattern: String, caseInsensitive: Boolean = false, dotAll: Boolean = false, extended: Boolean = false, matchEachLine: Boolean = false)

Matches documents where the field corresponds to a given regex expression.

Link copied to clipboard
abstract fun simplify(): BsonNode?

Returns a simplified (but equivalent) expression to the current expression.

Link copied to clipboard

Selects documents where the value of a field is an array of size size (exactly).

Link copied to clipboard

Writes the result of simplifying to a new BsonDocument.

Link copied to clipboard
abstract override fun toString(): String

JSON representation of this expression.

Link copied to clipboard
open infix fun <Root, Child> KProperty1<Root, *>.unsafe(child: String): Field<Root, Child>
open infix fun <Root, Type, Child> Field<Root, Type>.unsafe(child: String): Field<Root, Child>

Refers to a field child of the current field, with no compile-time safety.

open infix fun <Root, Child> KProperty1<Root, *>.unsafe(child: KProperty1<*, Child>): Field<Root, Child>
open infix fun <Root, Child> KProperty1<Root, *>.unsafe(child: Field<*, Child>): Field<Root, Child>
open infix fun <Root, Child> Field<Root, *>.unsafe(child: KProperty1<*, Child>): Field<Root, Child>
open infix fun <Root, Child> Field<Root, *>.unsafe(child: Field<*, Child>): Field<Root, Child>

Refers to a field child of the current field, without checking that it is a field available on the current object.

Link copied to clipboard
abstract override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.