UnwindStageOperators¶

interface UnwindStageOperators<In : Any, Item, Out : Any> : BsonNode, AggregationOperators, FieldDsl

Operators of the unwind stage.

Properties¶

`context`¶

@LowLevelApi
abstract val context: BsonContext

The context used to generate this expression.

`dayOfMonth`¶

open val <R : Any> KProperty1<R, Instant>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

open val Instant.dayOfMonth: Value<Any, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfObjectId")
val ObjectId.dayOfMonth: Value<Any, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfTimestamp")
val Timestamp.dayOfMonth: Value<Any, Int>

Returns the day of the month for a date as a number between 1 and 31.

open val <R : Any> Value<R, Instant>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfObjectId")
val <R : Any> Value<R, ObjectId>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfTimestamp")
val <R : Any> Value<R, Timestamp>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

open val <R : Any> Field<R, Instant>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfObjectId")
val <R : Any> Field<R, ObjectId>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

@get:JvmName(name = "dayOfMonthOfTimestamp")
val <R : Any> Field<R, Timestamp>.dayOfMonth: Value<R, Int>

Returns the day of the month for a date as a number between 1 and 31.

`dayOfWeekISO`¶

open val <R : Any> KProperty1<R, Instant>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

open val Instant.dayOfWeekISO: Value<Any, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfObjectId")
val ObjectId.dayOfWeekISO: Value<Any, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfTimestamp")
val Timestamp.dayOfWeekISO: Value<Any, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

open val <R : Any> Value<R, Instant>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfObjectId")
val <R : Any> Value<R, ObjectId>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfTimestamp")
val <R : Any> Value<R, Timestamp>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

open val <R : Any> Field<R, Instant>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfObjectId")
val <R : Any> Field<R, ObjectId>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

@get:JvmName(name = "dayOfWeekISOOfTimestamp")
val <R : Any> Field<R, Timestamp>.dayOfWeekISO: Value<R, Int>

Returns the day of the week in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).

`dayOfWeekUS`¶

open val <R : Any> KProperty1<R, Instant>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

open val Instant.dayOfWeekUS: Value<Any, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfObjectId")
val ObjectId.dayOfWeekUS: Value<Any, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfTimestamp")
val Timestamp.dayOfWeekUS: Value<Any, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

open val <R : Any> Value<R, Instant>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfObjectId")
val <R : Any> Value<R, ObjectId>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfTimestamp")
val <R : Any> Value<R, Timestamp>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

open val <R : Any> Field<R, Instant>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfObjectId")
val <R : Any> Field<R, ObjectId>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

@get:JvmName(name = "dayOfWeekUSOfTimestamp")
val <R : Any> Field<R, Timestamp>.dayOfWeekUS: Value<R, Int>

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

`dayOfYear`¶

open val <R : Any> KProperty1<R, Instant>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

open val Instant.dayOfYear: Value<Any, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfObjectId")
val ObjectId.dayOfYear: Value<Any, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfTimestamp")
val Timestamp.dayOfYear: Value<Any, Int>

Returns the day of the year for a date as a number between 1 and 366.

open val <R : Any> Value<R, Instant>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfObjectId")
val <R : Any> Value<R, ObjectId>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfTimestamp")
val <R : Any> Value<R, Timestamp>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

open val <R : Any> Field<R, Instant>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfObjectId")
val <R : Any> Field<R, ObjectId>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

@get:JvmName(name = "dayOfYearOfTimestamp")
val <R : Any> Field<R, Timestamp>.dayOfYear: Value<R, Int>

Returns the day of the year for a date as a number between 1 and 366.

`field`¶

open val <Root, Type> KProperty1<Root, Type>.field: Field<Root, Type>

Converts a Kotlin property into a Field.

`hour`¶

open val <R : Any> KProperty1<R, Instant>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

open val Instant.hour: Value<Any, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfObjectId")
val ObjectId.hour: Value<Any, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfTimestamp")
val Timestamp.hour: Value<Any, Int>

Returns the hour portion of a date as a number between 0 and 23.

open val <R : Any> Value<R, Instant>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfObjectId")
val <R : Any> Value<R, ObjectId>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfTimestamp")
val <R : Any> Value<R, Timestamp>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

open val <R : Any> Field<R, Instant>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfObjectId")
val <R : Any> Field<R, ObjectId>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

@get:JvmName(name = "hourOfTimestamp")
val <R : Any> Field<R, Timestamp>.hour: Value<R, Int>

Returns the hour portion of a date as a number between 0 and 23.

`length`¶

@get:JvmName(name = "getLengthNonNull")
val String.length: Value<Any, Int>

Returns the number of code points in the specified string.

open val String?.length: Value<Any, Int?>

Returns the number of code points in the specified string.

open val <Context : Any> KProperty1<Context, String?>.length: Value<Context, Int?>

Returns the number of code points in the specified string.

@get:JvmName(name = "getLengthNonNull")
val <Context : Any> KProperty1<Context, String>.length: Value<Context, Int>

Returns the number of code points in the specified string.

open val <Context : Any> Value<Context, String?>.length: Value<Context, Int?>

Returns the number of code points in the specified string.

@get:JvmName(name = "getLengthNonNull")
val <Context : Any> Value<Context, String>.length: Value<Context, Int>

Returns the number of code points in the specified string.

open val <Context : Any> Field<Context, String?>.length: Value<Context, Int?>

Returns the number of code points in the specified string.

@get:JvmName(name = "getLengthNonNull")
val <Context : Any> Field<Context, String>.length: Value<Context, Int>

Returns the number of code points in the specified string.

`lengthUTF8`¶

@get:JvmName(name = "getLengthUTF8NonNull")
val String.lengthUTF8: Value<Any, Int>

Returns the number of UTF-8 encoded bytes in the specified string.

open val String?.lengthUTF8: Value<Any, Int?>

Returns the number of UTF-8 encoded bytes in the specified string.

open val <Context : Any> KProperty1<Context, String?>.lengthUTF8: Value<Context, Int?>

Returns the number of UTF-8 encoded bytes in the specified string.

@get:JvmName(name = "getLengthUTF8NonNull")
val <Context : Any> KProperty1<Context, String>.lengthUTF8: Value<Context, Int>

Returns the number of UTF-8 encoded bytes in the specified string.

open val <Context : Any> Value<Context, String?>.lengthUTF8: Value<Context, Int?>

Returns the number of UTF-8 encoded bytes in the specified string.

@get:JvmName(name = "getLengthUTF8NonNull")
val <Context : Any> Value<Context, String>.lengthUTF8: Value<Context, Int>

Returns the number of UTF-8 encoded bytes in the specified string.

open val <Context : Any> Field<Context, String?>.lengthUTF8: Value<Context, Int?>

Returns the number of UTF-8 encoded bytes in the specified string.

@get:JvmName(name = "getLengthUTF8NonNull")
val <Context : Any> Field<Context, String>.lengthUTF8: Value<Context, Int>

Returns the number of UTF-8 encoded bytes in the specified string.

`millisecond`¶

open val <R : Any> KProperty1<R, Instant>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

open val Instant.millisecond: Value<Any, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfObjectId")
val ObjectId.millisecond: Value<Any, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfTimestamp")
val Timestamp.millisecond: Value<Any, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

open val <R : Any> Value<R, Instant>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfObjectId")
val <R : Any> Value<R, ObjectId>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfTimestamp")
val <R : Any> Value<R, Timestamp>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

open val <R : Any> Field<R, Instant>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfObjectId")
val <R : Any> Field<R, ObjectId>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

@get:JvmName(name = "millisecondOfTimestamp")
val <R : Any> Field<R, Timestamp>.millisecond: Value<R, Int>

Returns the millisecond portion of a date as a number between 0 and 999.

`minute`¶

open val <R : Any> KProperty1<R, Instant>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

open val Instant.minute: Value<Any, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfObjectId")
val ObjectId.minute: Value<Any, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfTimestamp")
val Timestamp.minute: Value<Any, Int>

Returns the minute portion of a date as a number between 0 and 59.

open val <R : Any> Value<R, Instant>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfObjectId")
val <R : Any> Value<R, ObjectId>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfTimestamp")
val <R : Any> Value<R, Timestamp>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

open val <R : Any> Field<R, Instant>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfObjectId")
val <R : Any> Field<R, ObjectId>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

@get:JvmName(name = "minuteOfTimestamp")
val <R : Any> Field<R, Timestamp>.minute: Value<R, Int>

Returns the minute portion of a date as a number between 0 and 59.

`month`¶

open val <R : Any> KProperty1<R, Instant>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

open val Instant.month: Value<Any, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfObjectId")
val ObjectId.month: Value<Any, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfTimestamp")
val Timestamp.month: Value<Any, Int>

Returns the month of a date as a number between 1 and 12.

open val <R : Any> Value<R, Instant>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfObjectId")
val <R : Any> Value<R, ObjectId>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfTimestamp")
val <R : Any> Value<R, Timestamp>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

open val <R : Any> Field<R, Instant>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfObjectId")
val <R : Any> Field<R, ObjectId>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

@get:JvmName(name = "monthOfTimestamp")
val <R : Any> Field<R, Timestamp>.month: Value<R, Int>

Returns the month of a date as a number between 1 and 12.

`second`¶

open val <R : Any> KProperty1<R, Instant>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

open val Instant.second: Value<Any, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfObjectId")
val ObjectId.second: Value<Any, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfTimestamp")
val Timestamp.second: Value<Any, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

open val <R : Any> Value<R, Instant>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfObjectId")
val <R : Any> Value<R, ObjectId>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfTimestamp")
val <R : Any> Value<R, Timestamp>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

open val <R : Any> Field<R, Instant>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfObjectId")
val <R : Any> Field<R, ObjectId>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

@get:JvmName(name = "secondOfTimestamp")
val <R : Any> Field<R, Timestamp>.second: Value<R, Int>

Returns the second portion of a date as a number between 0 and 60 (leap seconds).

`type`¶

open val Any?.type: Value<Any, BsonType>

Gets the BsonType of the current value.

open val <R : Any> KProperty1<R, *>.type: Value<R, BsonType>

Gets the BsonType of the current value.

open val <R : Any> Value<R, *>.type: Value<R, BsonType>

Gets the BsonType of the current value.

open val <R : Any> Field<R, *>.type: Value<R, BsonType>

Gets the BsonType of the current value.

`weekISO`¶

open val <R : Any> KProperty1<R, Instant>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

open val Instant.weekISO: Value<Any, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfObjectId")
val ObjectId.weekISO: Value<Any, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfTimestamp")
val Timestamp.weekISO: Value<Any, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

open val <R : Any> Value<R, Instant>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfObjectId")
val <R : Any> Value<R, ObjectId>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfTimestamp")
val <R : Any> Value<R, Timestamp>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

open val <R : Any> Field<R, Instant>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfObjectId")
val <R : Any> Field<R, ObjectId>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

@get:JvmName(name = "weekISOOfTimestamp")
val <R : Any> Field<R, Timestamp>.weekISO: Value<R, Int>

Returns the week number in ISO 8601 format, ranging from 1 to 53.

`weekUS`¶

open val <R : Any> KProperty1<R, Instant>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

open val Instant.weekUS: Value<Any, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfObjectId")
val ObjectId.weekUS: Value<Any, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfTimestamp")
val Timestamp.weekUS: Value<Any, Int>

Returns the week of the year for a date, ranging from 0 to 53.

open val <R : Any> Value<R, Instant>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfObjectId")
val <R : Any> Value<R, ObjectId>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfTimestamp")
val <R : Any> Value<R, Timestamp>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

open val <R : Any> Field<R, Instant>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfObjectId")
val <R : Any> Field<R, ObjectId>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

@get:JvmName(name = "weekUSOfTimestamp")
val <R : Any> Field<R, Timestamp>.weekUS: Value<R, Int>

Returns the week of the year for a date, ranging from 0 to 53.

`yearOfISOWeek`¶

open val <R : Any> KProperty1<R, Instant>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfObjectId")
val <R : Any> KProperty1<R, ObjectId>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfTimestamp")
val <R : Any> KProperty1<R, Timestamp>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

open val Instant.yearOfISOWeek: Value<Any, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfObjectId")
val ObjectId.yearOfISOWeek: Value<Any, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfTimestamp")
val Timestamp.yearOfISOWeek: Value<Any, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

open val <R : Any> Value<R, Instant>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfObjectId")
val <R : Any> Value<R, ObjectId>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfTimestamp")
val <R : Any> Value<R, Timestamp>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

open val <R : Any> Field<R, Instant>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfObjectId")
val <R : Any> Field<R, ObjectId>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

@get:JvmName(name = "yearOfISOWeekOfTimestamp")
val <R : Any> Field<R, Timestamp>.yearOfISOWeek: Value<R, Int>

Returns the year in ISO 8601 format, corresponding to the ISO week number returned by weekISO.

Functions¶

`acos`¶

@JvmName(name = "acosNonNull")
inline fun acos(value: Double): Value<Any, Double>

The inverse cosine (arc cosine) of a value, in radians.

inline fun acos(value: Double?): Value<Any, Double?>

The inverse cosine (arc cosine) of a value, in radians.

@JvmName(name = "acosByProperty")
open fun <Context : Any> acos(value: KProperty1<Context, Double?>): Value<Context, Double?>

The inverse cosine (arc cosine) of a value, in radians.

@JvmName(name = "acosNonNullByProperty")
fun <Context : Any> acos(value: KProperty1<Context, Double>): Value<Context, Double>

The inverse cosine (arc cosine) of a value, in radians.

open fun <Context : Any> acos(value: Value<Context, Double?>): Value<Context, Double?>

The inverse cosine (arc cosine) of a value, in radians.

@JvmName(name = "acosNonNull")
fun <Context : Any> acos(value: Value<Context, Double>): Value<Context, Double>

The inverse cosine (arc cosine) of a value, in radians.

@JvmName(name = "acosByField")
open fun <Context : Any> acos(value: Field<Context, Double?>): Value<Context, Double?>

The inverse cosine (arc cosine) of a value, in radians.

@JvmName(name = "acosNonNullByField")
fun <Context : Any> acos(value: Field<Context, Double>): Value<Context, Double>

The inverse cosine (arc cosine) of a value, in radians.

`acosh`¶

@JvmName(name = "acoshNonNull")
inline fun acosh(value: Double): Value<Any, Double>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

inline fun acosh(value: Double?): Value<Any, Double?>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

@JvmName(name = "acoshByProperty")
open fun <Context : Any> acosh(value: KProperty1<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

@JvmName(name = "acoshNonNullByProperty")
fun <Context : Any> acosh(value: KProperty1<Context, Double>): Value<Context, Double>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

open fun <Context : Any> acosh(value: Value<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

@JvmName(name = "acoshNonNull")
fun <Context : Any> acosh(value: Value<Context, Double>): Value<Context, Double>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

@JvmName(name = "acoshByField")
open fun <Context : Any> acosh(value: Field<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

@JvmName(name = "acoshNonNullByField")
fun <Context : Any> acosh(value: Field<Context, Double>): Value<Context, Double>

The inverse hyperbolic cosine (hyperbolic arc cosine) of a value, in radians.

array¶

abstract fun array(field: Field<In, Collection<Item>?>)

open fun array(field: KProperty1<In, Collection<Item>?>)

The array to be unwound.

Each document that contains the specified array will be duplicated the number of times of the array's length. Each generated document is identical to the original except that the specified array is replaced by an array of size 1 that corresponds to one of the items of the array.

For more information, see $unwind.

Example

class User(
    val _id: ObjectId,
    val name: String,
    val pets: List<Pet>
)

class Pet(
    val name: String,
    val age: Int,
)

class Result(
    val userId: ObjectId,
    val userName: String,
    val petName: String,
    val petAge: Int,
)

users.aggregate()
    .unwind {
        array(User::pets)

        project {
            Result::userId set User::name
            Result::userName set User::name
            Result::petName set (it / Pet::name)
            Result::petAge set (it / Pet::age)
        }
    }

Example input:

User(/* … */, "Alice", listOf(Pet("Bob", 5), Pet("Charlie", 6)))
 User(/* … */, "Damian", listOf(Pet("Eva", 2)))

Output:

Result(/* … */, "Alice", "Bob", 5)
 Result(/* … */, "Alice", "Charlie", 6)
 Result(/* … */, "Damian", "Eva", 2)

External resources

Official documentation

`asin`¶

@JvmName(name = "asinNonNull")
inline fun asin(value: Double): Value<Any, Double>

The inverse sine (arc sine) of a value, in radians.

inline fun asin(value: Double?): Value<Any, Double?>

The inverse sine (arc sine) of a value, in radians.

@JvmName(name = "asinByProperty")
open fun <Context : Any> asin(value: KProperty1<Context, Double?>): Value<Context, Double?>

The inverse sine (arc sine) of a value, in radians.

@JvmName(name = "asinNonNullByProperty")
fun <Context : Any> asin(value: KProperty1<Context, Double>): Value<Context, Double>

The inverse sine (arc sine) of a value, in radians.

open fun <Context : Any> asin(value: Value<Context, Double?>): Value<Context, Double?>

The inverse sine (arc sine) of a value, in radians.

@JvmName(name = "asinNonNull")
fun <Context : Any> asin(value: Value<Context, Double>): Value<Context, Double>

The inverse sine (arc sine) of a value, in radians.

@JvmName(name = "asinByField")
open fun <Context : Any> asin(value: Field<Context, Double?>): Value<Context, Double?>

The inverse sine (arc sine) of a value, in radians.

@JvmName(name = "asinNonNullByField")
fun <Context : Any> asin(value: Field<Context, Double>): Value<Context, Double>

The inverse sine (arc sine) of a value, in radians.

`asinh`¶

@JvmName(name = "asinhNonNull")
inline fun asinh(value: Double): Value<Any, Double>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

inline fun asinh(value: Double?): Value<Any, Double?>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

@JvmName(name = "asinhByProperty")
open fun <Context : Any> asinh(value: KProperty1<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

@JvmName(name = "asinhNonNullByProperty")
fun <Context : Any> asinh(value: KProperty1<Context, Double>): Value<Context, Double>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

open fun <Context : Any> asinh(value: Value<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

@JvmName(name = "asinhNonNull")
fun <Context : Any> asinh(value: Value<Context, Double>): Value<Context, Double>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

@JvmName(name = "asinhByField")
open fun <Context : Any> asinh(value: Field<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

@JvmName(name = "asinhNonNullByField")
fun <Context : Any> asinh(value: Field<Context, Double>): Value<Context, Double>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, in radians.

`atan`¶

@JvmName(name = "atanNonNull")
inline fun atan(value: Double): Value<Any, Double>

The inverse tangent (arc tangent) of a value, in radians.

inline fun atan(value: Double?): Value<Any, Double?>

The inverse tangent (arc tangent) of a value, in radians.

@JvmName(name = "atanByProperty")
open fun <Context : Any> atan(value: KProperty1<Context, Double?>): Value<Context, Double?>

The inverse tangent (arc tangent) of a value, in radians.

@JvmName(name = "atanNonNullByProperty")
fun <Context : Any> atan(value: KProperty1<Context, Double>): Value<Context, Double>

The inverse tangent (arc tangent) of a value, in radians.

open fun <Context : Any> atan(value: Value<Context, Double?>): Value<Context, Double?>

The inverse tangent (arc tangent) of a value, in radians.

@JvmName(name = "atanNonNull")
fun <Context : Any> atan(value: Value<Context, Double>): Value<Context, Double>

The inverse tangent (arc tangent) of a value, in radians.

@JvmName(name = "atanByField")
open fun <Context : Any> atan(value: Field<Context, Double?>): Value<Context, Double?>

The inverse tangent (arc tangent) of a value, in radians.

@JvmName(name = "atanNonNullByField")
fun <Context : Any> atan(value: Field<Context, Double>): Value<Context, Double>

The inverse tangent (arc tangent) of a value, in radians.

`atanh`¶

@JvmName(name = "atanhNonNull")
inline fun atanh(value: Double): Value<Any, Double>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

inline fun atanh(value: Double?): Value<Any, Double?>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

@JvmName(name = "atanhByProperty")
open fun <Context : Any> atanh(value: KProperty1<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

@JvmName(name = "atanhNonNullByProperty")
fun <Context : Any> atanh(value: KProperty1<Context, Double>): Value<Context, Double>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

open fun <Context : Any> atanh(value: Value<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

@JvmName(name = "atanhNonNull")
fun <Context : Any> atanh(value: Value<Context, Double>): Value<Context, Double>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

@JvmName(name = "atanhByField")
open fun <Context : Any> atanh(value: Field<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

@JvmName(name = "atanhNonNullByField")
fun <Context : Any> atanh(value: Field<Context, Double>): Value<Context, Double>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

`average`¶

open fun <Context : Any, T : Number> average(): Value<Context, T>

@JvmName(name = "averageResultReceiver")
open fun <Context : Any, T : Number> Collection<Number?>.average(): Value<Context, T>

Returns the average of the elements in the array.

open fun <Context : Any, T : Number> Iterable<Value<Context, Number?>>.average(): Value<Context, T>

Returns the average of the elements in the array.

@JvmName(name = "averagePropertyReceiver")
open fun <Context : Any, T : Number> KProperty1<Context, Collection<Number?>>.average(): Value<Context, T>

Returns the average of the elements in the array.

open fun <Context : Any, T : Number> Value<Context, Collection<Number?>>.average(): Value<Context, T>

Returns the average of the elements in the array.

@JvmName(name = "averageFieldReceiver")
open fun <Context : Any, T : Number> Field<Context, Collection<Number?>>.average(): Value<Context, T>

Returns the average of the elements in the array.

@JvmName(name = "averageByProperty")
open fun <Context : Any, T : Number> average(vararg input: KProperty1<Context, Number?>): Value<Context, T>

Returns the average of the elements in the array.

open fun <Context : Any, T : Number> average(vararg input: Value<Context, Number?>): Value<Context, T>

Returns the average of the elements in the array.

@JvmName(name = "averageByField")
open fun <Context : Any, T : Number> average(vararg input: Field<Context, Number?>): Value<Context, T>

Returns the average of the elements in the array.

`ceil`¶

inline fun <Context : Any, Result : Number?> ceil(value: Result): Value<Context, Result>

The smallest integer greater than or equal to the specified value.

@JvmName(name = "ceilByProperty")
open fun <Context : Any, Result : Number?> ceil(value: KProperty1<Context, Result>): Value<Context, Result>

The smallest integer greater than or equal to the specified value.

open fun <Context : Any, Result : Number?> ceil(value: Value<Context, Result>): Value<Context, Result>

The smallest integer greater than or equal to the specified value.

@JvmName(name = "ceilByField")
open fun <Context : Any, Result : Number?> ceil(value: Field<Context, Result>): Value<Context, Result>

The smallest integer greater than or equal to the specified value.

`concat`¶

open fun <Context : Any> concat(strings: List<Value<Context, String?>>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatNonNull")
fun <Context : Any> concat(strings: List<Value<Context, String>>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatByProperty")
open fun <Context : Any> concat(vararg strings: KProperty1<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatNonNullByProperty")
fun <Context : Any> concat(vararg strings: KProperty1<Context, String>): Value<Context, String>

Concatenates strings together.

open fun <Context : Any> concat(vararg strings: Value<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatNonNull")
fun <Context : Any> concat(vararg strings: Value<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatByField")
open fun <Context : Any> concat(vararg strings: Field<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatNonNullByField")
fun <Context : Any> concat(vararg strings: Field<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullResultReceiverByResult")
infix inline fun String.concat(other: String): Value<Any, String>

Concatenates strings together.

@JvmName(name = "concatNonNullResultReceiverByProperty")
infix inline fun <Context : Any> String.concat(other: KProperty1<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullResultReceiverByValue")
infix inline fun <Context : Any> String.concat(other: Value<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullResultReceiverByField")
infix inline fun <Context : Any> String.concat(other: Field<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatResultReceiverByResult")
infix inline fun String?.concat(other: String?): Value<Any, String?>

Concatenates strings together.

@JvmName(name = "concatResultReceiverByProperty")
infix inline fun <Context : Any> String?.concat(other: KProperty1<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatResultReceiverByValue")
infix inline fun <Context : Any> String?.concat(other: Value<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatResultReceiverByField")
infix inline fun <Context : Any> String?.concat(other: Field<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatPropertyReceiverByResult")
infix inline fun <Context : Any> KProperty1<Context, String?>.concat(other: String?): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatPropertyReceiverByProperty")
open infix fun <Context : Any> KProperty1<Context, String?>.concat(other: KProperty1<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatPropertyReceiverByValue")
open infix fun <Context : Any> KProperty1<Context, String?>.concat(other: Value<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatPropertyReceiverByField")
open infix fun <Context : Any> KProperty1<Context, String?>.concat(other: Field<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatNonNullPropertyReceiverByResult")
infix inline fun <Context : Any> KProperty1<Context, String>.concat(other: String): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullPropertyReceiverByProperty")
infix fun <Context : Any> KProperty1<Context, String>.concat(other: KProperty1<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullPropertyReceiverByValue")
infix fun <Context : Any> KProperty1<Context, String>.concat(other: Value<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullPropertyReceiverByField")
infix fun <Context : Any> KProperty1<Context, String>.concat(other: Field<Context, String>): Value<Context, String>

Concatenates strings together.

infix inline fun <Context : Any> Value<Context, String?>.concat(other: String?): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatByProperty")
open infix fun <Context : Any> Value<Context, String?>.concat(other: KProperty1<Context, String?>): Value<Context, String?>

Concatenates strings together.

open infix fun <Context : Any> Value<Context, String?>.concat(other: Value<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatByField")
open infix fun <Context : Any> Value<Context, String?>.concat(other: Field<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatNonNull")
infix inline fun <Context : Any> Value<Context, String>.concat(other: String): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullByProperty")
infix fun <Context : Any> Value<Context, String>.concat(other: KProperty1<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNull")
infix fun <Context : Any> Value<Context, String>.concat(other: Value<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullByField")
infix fun <Context : Any> Value<Context, String>.concat(other: Field<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatFieldReceiverByResult")
infix inline fun <Context : Any> Field<Context, String?>.concat(other: String?): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatFieldReceiverByProperty")
open infix fun <Context : Any> Field<Context, String?>.concat(other: KProperty1<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatFieldReceiverByValue")
open infix fun <Context : Any> Field<Context, String?>.concat(other: Value<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatFieldReceiverByField")
open infix fun <Context : Any> Field<Context, String?>.concat(other: Field<Context, String?>): Value<Context, String?>

Concatenates strings together.

@JvmName(name = "concatNonNullFieldReceiverByResult")
infix inline fun <Context : Any> Field<Context, String>.concat(other: String): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullFieldReceiverByProperty")
infix fun <Context : Any> Field<Context, String>.concat(other: KProperty1<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullFieldReceiverByValue")
infix fun <Context : Any> Field<Context, String>.concat(other: Value<Context, String>): Value<Context, String>

Concatenates strings together.

@JvmName(name = "concatNonNullFieldReceiverByField")
infix fun <Context : Any> Field<Context, String>.concat(other: Field<Context, String>): Value<Context, String>

Concatenates strings together.

`cond`¶

inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: T, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByResultByProperty")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: T, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: T, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByResultByField")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: T, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByPropertyByResult")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByPropertyByProperty")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByPropertyByValue")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByPropertyByField")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Value<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByValueByProperty")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Value<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Value<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByValueByField")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Value<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByFieldByResult")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Field<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByFieldByProperty")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Field<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByFieldByValue")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Field<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByResultByFieldByField")
inline fun <R : Any, T> cond(
    condition: Boolean, 
    ifTrue: Field<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByResultByResult")
inline fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: T, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByResultByProperty")
inline fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: T, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByResultByValue")
inline fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: T, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByResultByField")
inline fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: T, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByPropertyByResult")
inline fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByPropertyByProperty")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByPropertyByValue")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByPropertyByField")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByValueByResult")
inline fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByValueByProperty")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByValueByValue")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByValueByField")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByFieldByResult")
inline fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByFieldByProperty")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByFieldByValue")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByPropertyByFieldByField")
open fun <R : Any, T> cond(
    condition: KProperty1<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

inline fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: T, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByResultByProperty")
inline fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: T, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

inline fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: T, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByResultByField")
inline fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: T, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByPropertyByResult")
inline fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByPropertyByProperty")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByPropertyByValue")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByPropertyByField")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

inline fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByValueByProperty")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByValueByField")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByFieldByResult")
inline fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByFieldByProperty")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByFieldByValue")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByValueByFieldByField")
open fun <R : Any, T> cond(
    condition: Value<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByResultByResult")
inline fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: T, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByResultByProperty")
inline fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: T, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByResultByValue")
inline fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: T, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByResultByField")
inline fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: T, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByPropertyByResult")
inline fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByPropertyByProperty")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByPropertyByValue")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByPropertyByField")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: KProperty1<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByValueByResult")
inline fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByValueByProperty")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByValueByValue")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByValueByField")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Value<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByFieldByResult")
inline fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: T
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByFieldByProperty")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: KProperty1<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByFieldByValue")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: Value<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

@JvmName(name = "condByFieldByFieldByField")
open fun <R : Any, T> cond(
    condition: Field<R, Boolean>, 
    ifTrue: Field<R, T>, 
    ifFalse: Field<R, T>
): Value<R, T>

Decides between two values depending on the evaluation of a boolean value.

`cos`¶

@JvmName(name = "cosNonNull")
inline fun cos(value: Double): Value<Any, Double>

The cosine of a value that is measured in radians.

inline fun cos(value: Double?): Value<Any, Double?>

The cosine of a value that is measured in radians.

@JvmName(name = "cosByProperty")
open fun <Context : Any> cos(value: KProperty1<Context, Double?>): Value<Context, Double?>

The cosine of a value that is measured in radians.

@JvmName(name = "cosNonNullByProperty")
fun <Context : Any> cos(value: KProperty1<Context, Double>): Value<Context, Double>

The cosine of a value that is measured in radians.

open fun <Context : Any> cos(value: Value<Context, Double?>): Value<Context, Double?>

The cosine of a value that is measured in radians.

@JvmName(name = "cosNonNull")
fun <Context : Any> cos(value: Value<Context, Double>): Value<Context, Double>

The cosine of a value that is measured in radians.

@JvmName(name = "cosByField")
open fun <Context : Any> cos(value: Field<Context, Double?>): Value<Context, Double?>

The cosine of a value that is measured in radians.

@JvmName(name = "cosNonNullByField")
fun <Context : Any> cos(value: Field<Context, Double>): Value<Context, Double>

The cosine of a value that is measured in radians.

`cosh`¶

@JvmName(name = "coshNonNull")
inline fun cosh(value: Double): Value<Any, Double>

The hyperbolic cosine of a value that is measured in radians.

inline fun cosh(value: Double?): Value<Any, Double?>

The hyperbolic cosine of a value that is measured in radians.

@JvmName(name = "coshByProperty")
open fun <Context : Any> cosh(value: KProperty1<Context, Double?>): Value<Context, Double?>

The hyperbolic cosine of a value that is measured in radians.

@JvmName(name = "coshNonNullByProperty")
fun <Context : Any> cosh(value: KProperty1<Context, Double>): Value<Context, Double>

The hyperbolic cosine of a value that is measured in radians.

open fun <Context : Any> cosh(value: Value<Context, Double?>): Value<Context, Double?>

The hyperbolic cosine of a value that is measured in radians.

@JvmName(name = "coshNonNull")
fun <Context : Any> cosh(value: Value<Context, Double>): Value<Context, Double>

The hyperbolic cosine of a value that is measured in radians.

@JvmName(name = "coshByField")
open fun <Context : Any> cosh(value: Field<Context, Double?>): Value<Context, Double?>

The hyperbolic cosine of a value that is measured in radians.

@JvmName(name = "coshNonNullByField")
fun <Context : Any> cosh(value: Field<Context, Double>): Value<Context, Double>

The hyperbolic cosine of a value that is measured in radians.

`div`¶

@JvmName(name = "divResultReceiverByResult")
infix inline fun <Context : Any, Result> Result.div(other: Result): Value<Context, Result>

Divides one aggregation value by another.

@JvmName(name = "divResultReceiverByValue")
infix inline fun <Context : Any, Result> Result.div(other: Value<Context, Result>): Value<Context, Result>

Divides one aggregation value by another.

@JvmName(name = "divResultReceiverByField")
infix inline fun <Context : Any, Result> Result.div(other: Field<Context, Result>): Value<Context, Result>

Divides one aggregation value by another.

infix inline fun <Context : Any, Result> Value<Context, Result>.div(other: Result): Value<Context, Result>

Divides one aggregation value by another.

open infix fun <Context : Any, Result> Value<Context, Result>.div(other: Value<Context, Result>): Value<Context, Result>

Divides one aggregation value by another.

@JvmName(name = "divByField")
open infix fun <Context : Any, Result> Value<Context, Result>.div(other: Field<Context, Result>): Value<Context, Result>

Divides one aggregation value by another.

@JvmName(name = "divFieldReceiverByResult")
infix inline fun <Context : Any, Result> Field<Context, Result>.div(other: Result): Value<Context, Result>

Divides one aggregation value by another.

@JvmName(name = "divFieldReceiverByValue")
open infix fun <Context : Any, Result> Field<Context, Result>.div(other: Value<Context, Result>): Value<Context, Result>

Divides one aggregation value by another.

@JvmName(name = "divFieldReceiverByField")
open infix fun <Context : Any, Result> Field<Context, Result>.div(other: Field<Context, Result>): Value<Context, Result>

Divides one aggregation value by another.

open operator fun <Context : Any, Root, Child> Value<Context, Root>.div(field: KProperty1<Root, Child>): Value<Context, Child>

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

open operator fun <Context : Any, Root, Child> Value<Context, Root>.div(field: Field<Root, Child>): Value<Context, Child>

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

open operator fun <Root, Parent, Child> KProperty1<Root, Parent>.div(child: KProperty1<Parent & Any, Child>): Field<Root, Child>

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

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

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

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.

`eq`¶

@JvmName(name = "eqResultReceiverByResult")
infix inline fun <Context : Any, Result> Result.eq(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqResultReceiverByProperty")
infix inline fun <Context : Any, Result> Result.eq(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqResultReceiverByValue")
infix inline fun <Context : Any, Result> Result.eq(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqResultReceiverByField")
infix inline fun <Context : Any, Result> Result.eq(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqPropertyReceiverByResult")
infix inline fun <Context : Any, Result> KProperty1<Context, Result>.eq(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqPropertyReceiverByProperty")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.eq(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqPropertyReceiverByValue")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.eq(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqPropertyReceiverByField")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.eq(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

infix inline fun <Context : Any, Result> Value<Context, Result>.eq(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqByProperty")
open infix fun <Context : Any, Result> Value<Context, Result>.eq(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

open infix fun <Context : Any, Result> Value<Context, Result>.eq(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqByField")
open infix fun <Context : Any, Result> Value<Context, Result>.eq(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqFieldReceiverByResult")
infix inline fun <Context : Any, Result> Field<Context, Result>.eq(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqFieldReceiverByProperty")
open infix fun <Context : Any, Result> Field<Context, Result>.eq(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqFieldReceiverByValue")
open infix fun <Context : Any, Result> Field<Context, Result>.eq(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

@JvmName(name = "eqFieldReceiverByField")
open infix fun <Context : Any, Result> Field<Context, Result>.eq(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are equivalent.

`filter`¶

@JvmName(name = "filterResultReceiverByResult")
open fun <Context : Any, T> Collection<T>.filter(
    limit: Int, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterResultReceiverByProperty")
open fun <Context : Any, T> Collection<T>.filter(
    limit: KProperty1<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterResultReceiverByValue")
open fun <Context : Any, T> Collection<T>.filter(
    limit: Value<Context, Int>? = null, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterResultReceiverByField")
open fun <Context : Any, T> Collection<T>.filter(
    limit: Field<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterPropertyReceiverByResult")
open fun <Context : Any, T> KProperty1<Context, Collection<T>>.filter(
    limit: Int, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterPropertyReceiverByProperty")
open fun <Context : Any, T> KProperty1<Context, Collection<T>>.filter(
    limit: KProperty1<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterPropertyReceiverByValue")
open fun <Context : Any, T> KProperty1<Context, Collection<T>>.filter(
    limit: Value<Context, Int>? = null, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterPropertyReceiverByField")
open fun <Context : Any, T> KProperty1<Context, Collection<T>>.filter(
    limit: Field<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

open fun <Context : Any, T> Value<Context, Collection<T>>.filter(
    limit: Int, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterByProperty")
open fun <Context : Any, T> Value<Context, Collection<T>>.filter(
    limit: KProperty1<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

open fun <Context : Any, T> Value<Context, Collection<T>>.filter(
    limit: Value<Context, Int>? = null, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterByField")
open fun <Context : Any, T> Value<Context, Collection<T>>.filter(
    limit: Field<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterFieldReceiverByResult")
open fun <Context : Any, T> Field<Context, Collection<T>>.filter(
    limit: Int, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterFieldReceiverByProperty")
open fun <Context : Any, T> Field<Context, Collection<T>>.filter(
    limit: KProperty1<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterFieldReceiverByValue")
open fun <Context : Any, T> Field<Context, Collection<T>>.filter(
    limit: Value<Context, Int>? = null, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

@JvmName(name = "filterFieldReceiverByField")
open fun <Context : Any, T> Field<Context, Collection<T>>.filter(
    limit: Field<Context, Int>, 
    variableName: String = "this", 
    predicate: AggregationOperators.(Value<Any, T>) -> Value<T & Any, Boolean>
): Value<Context, List<T>>

Selects a subset of an array to return based on the specified predicate, similarly to Kotlin'sfilter``.

`floor`¶

inline fun <Context : Any, Result : Number?> floor(value: Result): Value<Context, Result>

The largest integer less than or equal to the specified value.

@JvmName(name = "floorByProperty")
open fun <Context : Any, Result : Number?> floor(value: KProperty1<Context, Result>): Value<Context, Result>

The largest integer less than or equal to the specified value.

open fun <Context : Any, Result : Number?> floor(value: Value<Context, Result>): Value<Context, Result>

The largest integer less than or equal to the specified value.

@JvmName(name = "floorByField")
open fun <Context : Any, Result : Number?> floor(value: Field<Context, Result>): Value<Context, Result>

The largest integer less than or equal to the specified value.

`freeze`¶

@LowLevelApi
abstract override fun freeze()

Makes this node immutable.

`get`¶

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: Int): Value<Context, Result>

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

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: KProperty1<Context, Int>): Value<Context, Result>

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

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: Value<Context, Int>): Value<Context, Result>

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

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: Field<Context, Int>): Value<Context, Result>

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

@JvmName(name = "bsonItem")
operator fun <Context : Any, Child> Value<Context, BsonArray>.get(index: Int): Value<Context, Child>

Refers to a child field of a field of type BsonDocument.

@JvmName(name = "bsonField")
operator fun <Context : Any, Child> Value<Context, BsonDocument>.get(field: String): Value<Context, Child>

Refers to a child field of a field of type BsonDocument.

open operator fun <Root, Type> KProperty1<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>

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

@JvmName(name = "bsonItem")
operator fun <Root, Child> KProperty1<Root, BsonArray>.get(index: Int): Field<Root, Child>

Refers to a child item of a field of type BsonArray.

@JvmName(name = "bsonField")
operator fun <Root, Child> KProperty1<Root, BsonDocument>.get(field: String): Field<Root, Child>

Refers to a child field of a field of type BsonDocument.

@JvmName(name = "bsonField")
operator fun <Child> BsonDocument.Companion.get(field: String): Field<BsonDocument, Child>

Refers to a root field of the document being analyzed.

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> Field<Root, Map<String, Type>>.get(key: String): Field<Root, Type>

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

@JvmName(name = "bsonItem")
operator fun <Root, Child> Field<Root, BsonArray>.get(index: Int): Field<Root, Child>

Refers to a child item of a field of type BsonArray.

@JvmName(name = "bsonField")
operator fun <Root, Child> Field<Root, BsonDocument>.get(field: String): Field<Root, Child>

Refers to a child field of a field of type BsonDocument.

`gt`¶

@JvmName(name = "gtResultReceiverByResult")
infix inline fun <Context : Any, Result> Result.gt(other: Result): Value<Context, Boolean>

@JvmName(name = "gtResultReceiverByProperty")
infix inline fun <Context : Any, Result> Result.gt(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtResultReceiverByValue")
infix inline fun <Context : Any, Result> Result.gt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtResultReceiverByField")
infix inline fun <Context : Any, Result> Result.gt(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtPropertyReceiverByResult")
infix inline fun <Context : Any, Result> KProperty1<Context, Result>.gt(other: Result): Value<Context, Boolean>

@JvmName(name = "gtPropertyReceiverByProperty")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.gt(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtPropertyReceiverByValue")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.gt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtPropertyReceiverByField")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.gt(other: Field<Context, Result>): Value<Context, Boolean>

infix inline fun <Context : Any, Result> Value<Context, Result>.gt(other: Result): Value<Context, Boolean>

@JvmName(name = "gtByProperty")
open infix fun <Context : Any, Result> Value<Context, Result>.gt(other: KProperty1<Context, Result>): Value<Context, Boolean>

open infix fun <Context : Any, Result> Value<Context, Result>.gt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtByField")
open infix fun <Context : Any, Result> Value<Context, Result>.gt(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtFieldReceiverByResult")
infix inline fun <Context : Any, Result> Field<Context, Result>.gt(other: Result): Value<Context, Boolean>

@JvmName(name = "gtFieldReceiverByProperty")
open infix fun <Context : Any, Result> Field<Context, Result>.gt(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtFieldReceiverByValue")
open infix fun <Context : Any, Result> Field<Context, Result>.gt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtFieldReceiverByField")
open infix fun <Context : Any, Result> Field<Context, Result>.gt(other: Field<Context, Result>): Value<Context, Boolean>

`gte`¶

@JvmName(name = "gteResultReceiverByResult")
infix inline fun <Context : Any, Result> Result.gte(other: Result): Value<Context, Boolean>

@JvmName(name = "gteResultReceiverByProperty")
infix inline fun <Context : Any, Result> Result.gte(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gteResultReceiverByValue")
infix inline fun <Context : Any, Result> Result.gte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gteResultReceiverByField")
infix inline fun <Context : Any, Result> Result.gte(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtePropertyReceiverByResult")
infix inline fun <Context : Any, Result> KProperty1<Context, Result>.gte(other: Result): Value<Context, Boolean>

@JvmName(name = "gtePropertyReceiverByProperty")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.gte(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtePropertyReceiverByValue")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.gte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gtePropertyReceiverByField")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.gte(other: Field<Context, Result>): Value<Context, Boolean>

infix inline fun <Context : Any, Result> Value<Context, Result>.gte(other: Result): Value<Context, Boolean>

@JvmName(name = "gteByProperty")
open infix fun <Context : Any, Result> Value<Context, Result>.gte(other: KProperty1<Context, Result>): Value<Context, Boolean>

open infix fun <Context : Any, Result> Value<Context, Result>.gte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gteByField")
open infix fun <Context : Any, Result> Value<Context, Result>.gte(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gteFieldReceiverByResult")
infix inline fun <Context : Any, Result> Field<Context, Result>.gte(other: Result): Value<Context, Boolean>

@JvmName(name = "gteFieldReceiverByProperty")
open infix fun <Context : Any, Result> Field<Context, Result>.gte(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gteFieldReceiverByValue")
open infix fun <Context : Any, Result> Field<Context, Result>.gte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "gteFieldReceiverByField")
open infix fun <Context : Any, Result> Field<Context, Result>.gte(other: Field<Context, Result>): Value<Context, Boolean>

`lowercase`¶

@JvmName(name = "lowercaseResultReceiver")
inline fun String?.lowercase(): Value<Any, String?>

Converts a string to lowercase, returning the result.

@JvmName(name = "lowercasePropertyReceiver")
open fun <Context : Any> KProperty1<Context, String?>.lowercase(): Value<Context, String?>

Converts a string to lowercase, returning the result.

open fun <Context : Any> Value<Context, String?>.lowercase(): Value<Context, String?>

Converts a string to lowercase, returning the result.

@JvmName(name = "lowercaseFieldReceiver")
open fun <Context : Any> Field<Context, String?>.lowercase(): Value<Context, String?>

Converts a string to lowercase, returning the result.

`lt`¶

@JvmName(name = "ltResultReceiverByResult")
infix inline fun <Context : Any, Result> Result.lt(other: Result): Value<Context, Boolean>

@JvmName(name = "ltResultReceiverByProperty")
infix inline fun <Context : Any, Result> Result.lt(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltResultReceiverByValue")
infix inline fun <Context : Any, Result> Result.lt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltResultReceiverByField")
infix inline fun <Context : Any, Result> Result.lt(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltPropertyReceiverByResult")
infix inline fun <Context : Any, Result> KProperty1<Context, Result>.lt(other: Result): Value<Context, Boolean>

@JvmName(name = "ltPropertyReceiverByProperty")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.lt(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltPropertyReceiverByValue")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.lt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltPropertyReceiverByField")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.lt(other: Field<Context, Result>): Value<Context, Boolean>

infix inline fun <Context : Any, Result> Value<Context, Result>.lt(other: Result): Value<Context, Boolean>

@JvmName(name = "ltByProperty")
open infix fun <Context : Any, Result> Value<Context, Result>.lt(other: KProperty1<Context, Result>): Value<Context, Boolean>

open infix fun <Context : Any, Result> Value<Context, Result>.lt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltByField")
open infix fun <Context : Any, Result> Value<Context, Result>.lt(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltFieldReceiverByResult")
infix inline fun <Context : Any, Result> Field<Context, Result>.lt(other: Result): Value<Context, Boolean>

@JvmName(name = "ltFieldReceiverByProperty")
open infix fun <Context : Any, Result> Field<Context, Result>.lt(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltFieldReceiverByValue")
open infix fun <Context : Any, Result> Field<Context, Result>.lt(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltFieldReceiverByField")
open infix fun <Context : Any, Result> Field<Context, Result>.lt(other: Field<Context, Result>): Value<Context, Boolean>

`lte`¶

@JvmName(name = "lteResultReceiverByResult")
infix inline fun <Context : Any, Result> Result.lte(other: Result): Value<Context, Boolean>

@JvmName(name = "lteResultReceiverByProperty")
infix inline fun <Context : Any, Result> Result.lte(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "lteResultReceiverByValue")
infix inline fun <Context : Any, Result> Result.lte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "lteResultReceiverByField")
infix inline fun <Context : Any, Result> Result.lte(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltePropertyReceiverByResult")
infix inline fun <Context : Any, Result> KProperty1<Context, Result>.lte(other: Result): Value<Context, Boolean>

@JvmName(name = "ltePropertyReceiverByProperty")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.lte(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltePropertyReceiverByValue")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.lte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "ltePropertyReceiverByField")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.lte(other: Field<Context, Result>): Value<Context, Boolean>

infix inline fun <Context : Any, Result> Value<Context, Result>.lte(other: Result): Value<Context, Boolean>

@JvmName(name = "lteByProperty")
open infix fun <Context : Any, Result> Value<Context, Result>.lte(other: KProperty1<Context, Result>): Value<Context, Boolean>

open infix fun <Context : Any, Result> Value<Context, Result>.lte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "lteByField")
open infix fun <Context : Any, Result> Value<Context, Result>.lte(other: Field<Context, Result>): Value<Context, Boolean>

@JvmName(name = "lteFieldReceiverByResult")
infix inline fun <Context : Any, Result> Field<Context, Result>.lte(other: Result): Value<Context, Boolean>

@JvmName(name = "lteFieldReceiverByProperty")
open infix fun <Context : Any, Result> Field<Context, Result>.lte(other: KProperty1<Context, Result>): Value<Context, Boolean>

@JvmName(name = "lteFieldReceiverByValue")
open infix fun <Context : Any, Result> Field<Context, Result>.lte(other: Value<Context, Result>): Value<Context, Boolean>

@JvmName(name = "lteFieldReceiverByField")
open infix fun <Context : Any, Result> Field<Context, Result>.lte(other: Field<Context, Result>): Value<Context, Boolean>

`map`¶

@JvmName(name = "mapResultReceiver")
open fun <Context : Any, T, R> Collection<T>.map(variableName: String = "this", transform: AggregationOperators.(Value<Any, T>) -> Value<Context, R>): Value<Context, List<R>>

Applies a transform to all elements in an array and returns the array with the applied results, similar to kotlin.collections.map.

@JvmName(name = "mapPropertyReceiver")
open fun <Context : Any, T, R> KProperty1<Context, Collection<T>>.map(variableName: String = "this", transform: AggregationOperators.(Value<Any, T>) -> Value<Context, R>): Value<Context, List<R>>

Applies a transform to all elements in an array and returns the array with the applied results, similar to kotlin.collections.map.

open fun <Context : Any, T, R> Value<Context, Collection<T>>.map(variableName: String = "this", transform: AggregationOperators.(Value<Any, T>) -> Value<Context, R>): Value<Context, List<R>>

Applies a transform to all elements in an array and returns the array with the applied results, similar to kotlin.collections.map.

@JvmName(name = "mapFieldReceiver")
open fun <Context : Any, T, R> Field<Context, Collection<T>>.map(variableName: String = "this", transform: AggregationOperators.(Value<Any, T>) -> Value<Context, R>): Value<Context, List<R>>

Applies a transform to all elements in an array and returns the array with the applied results, similar to kotlin.collections.map.

`minus`¶

@JvmName(name = "minusResultReceiverByResult")
inline operator fun <Context : Any, Result> Result.minus(other: Result): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusResultReceiverByProperty")
inline operator fun <Context : Any, Result> Result.minus(other: KProperty1<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusResultReceiverByValue")
inline operator fun <Context : Any, Result> Result.minus(other: Value<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusResultReceiverByField")
inline operator fun <Context : Any, Result> Result.minus(other: Field<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusPropertyReceiverByResult")
inline operator fun <Context : Any, Result> KProperty1<Context, Result>.minus(other: Result): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusPropertyReceiverByProperty")
open operator fun <Context : Any, Result> KProperty1<Context, Result>.minus(other: KProperty1<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusPropertyReceiverByValue")
open operator fun <Context : Any, Result> KProperty1<Context, Result>.minus(other: Value<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusPropertyReceiverByField")
open operator fun <Context : Any, Result> KProperty1<Context, Result>.minus(other: Field<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

inline operator fun <Context : Any, Result> Value<Context, Result>.minus(other: Result): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusByProperty")
open operator fun <Context : Any, Result> Value<Context, Result>.minus(other: KProperty1<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

open operator fun <Context : Any, Result> Value<Context, Result>.minus(other: Value<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusByField")
open operator fun <Context : Any, Result> Value<Context, Result>.minus(other: Field<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusFieldReceiverByResult")
inline operator fun <Context : Any, Result> Field<Context, Result>.minus(other: Result): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusFieldReceiverByProperty")
open operator fun <Context : Any, Result> Field<Context, Result>.minus(other: KProperty1<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusFieldReceiverByValue")
open operator fun <Context : Any, Result> Field<Context, Result>.minus(other: Value<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

@JvmName(name = "minusFieldReceiverByField")
open operator fun <Context : Any, Result> Field<Context, Result>.minus(other: Field<Context, Result>): Value<Context, Result>

Subtracts one aggregation value from another.

`ne`¶

@JvmName(name = "neResultReceiverByResult")
infix inline fun <Context : Any, Result> Result.ne(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neResultReceiverByProperty")
infix inline fun <Context : Any, Result> Result.ne(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neResultReceiverByValue")
infix inline fun <Context : Any, Result> Result.ne(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neResultReceiverByField")
infix inline fun <Context : Any, Result> Result.ne(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "nePropertyReceiverByResult")
infix inline fun <Context : Any, Result> KProperty1<Context, Result>.ne(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "nePropertyReceiverByProperty")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.ne(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "nePropertyReceiverByValue")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.ne(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "nePropertyReceiverByField")
open infix fun <Context : Any, Result> KProperty1<Context, Result>.ne(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

infix inline fun <Context : Any, Result> Value<Context, Result>.ne(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neByProperty")
open infix fun <Context : Any, Result> Value<Context, Result>.ne(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

open infix fun <Context : Any, Result> Value<Context, Result>.ne(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neByField")
open infix fun <Context : Any, Result> Value<Context, Result>.ne(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neFieldReceiverByResult")
infix inline fun <Context : Any, Result> Field<Context, Result>.ne(other: Result): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neFieldReceiverByProperty")
open infix fun <Context : Any, Result> Field<Context, Result>.ne(other: KProperty1<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neFieldReceiverByValue")
open infix fun <Context : Any, Result> Field<Context, Result>.ne(other: Value<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

@JvmName(name = "neFieldReceiverByField")
open infix fun <Context : Any, Result> Field<Context, Result>.ne(other: Field<Context, Result>): Value<Context, Boolean>

Compares two aggregation values and returns true if they are not equivalent.

`of`¶

inline fun <Result> of(value: Result): Value<Any, Result>

Refers to a Kotlin value within an aggregation value.

open fun <Context : Any, Result> of(field: KProperty1<Context, Result>): Value<Context, Result>

Refers to a field within an aggregation value.

open fun of(value: BsonType): Value<Any, BsonType>

Refers to a BsonType within an aggregation value.

open fun <Context : Any, Result> of(field: Field<Context, Result>): Value<Context, Result>

Refers to a field within an aggregation value.

open fun <Result> of(value: Result, type: KType): Value<Any, Result>

Refers to a Kotlin value within an aggregation value.

`plus`¶

@JvmName(name = "plusResultReceiverByResult")
inline operator fun <Context : Any, Result> Result.plus(other: Result): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusResultReceiverByProperty")
inline operator fun <Context : Any, Result> Result.plus(other: KProperty1<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusResultReceiverByValue")
inline operator fun <Context : Any, Result> Result.plus(other: Value<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusResultReceiverByField")
inline operator fun <Context : Any, Result> Result.plus(other: Field<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusPropertyReceiverByResult")
inline operator fun <Context : Any, Result> KProperty1<Context, Result>.plus(other: Result): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusPropertyReceiverByProperty")
open operator fun <Context : Any, Result> KProperty1<Context, Result>.plus(other: KProperty1<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusPropertyReceiverByValue")
open operator fun <Context : Any, Result> KProperty1<Context, Result>.plus(other: Value<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusPropertyReceiverByField")
open operator fun <Context : Any, Result> KProperty1<Context, Result>.plus(other: Field<Context, Result>): Value<Context, Result>

Sums two aggregation values.

inline operator fun <Context : Any, Result> Value<Context, Result>.plus(other: Result): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusByProperty")
open operator fun <Context : Any, Result> Value<Context, Result>.plus(other: KProperty1<Context, Result>): Value<Context, Result>

Sums two aggregation values.

open operator fun <Context : Any, Result> Value<Context, Result>.plus(other: Value<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusByField")
open operator fun <Context : Any, Result> Value<Context, Result>.plus(other: Field<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusFieldReceiverByResult")
inline operator fun <Context : Any, Result> Field<Context, Result>.plus(other: Result): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusFieldReceiverByProperty")
open operator fun <Context : Any, Result> Field<Context, Result>.plus(other: KProperty1<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusFieldReceiverByValue")
open operator fun <Context : Any, Result> Field<Context, Result>.plus(other: Value<Context, Result>): Value<Context, Result>

Sums two aggregation values.

@JvmName(name = "plusFieldReceiverByField")
open operator fun <Context : Any, Result> Field<Context, Result>.plus(other: Field<Context, Result>): Value<Context, Result>

Sums two aggregation values.

preserveNullAndEmptyArrays¶

abstract fun preserveNullAndEmptyArrays()

Controls the behavior of this stage when encountering missing fields, null and empty arrays.

By default, if this function is NOT called, null, missing and empty arrays are ignored: no output documents are created for them.

If this function is called:

If the array field is missing or an empty array, a single document is output with the array field missing.
If the array field is null, a single document is output with the array field set to null.

External resources

Official documentation

project¶

abstract fun project(block: ProjectStageOperators<In, Out>.(item: Value<In, Item?>) -> Unit)

Immediately declares a $project stage that follows this $unwind stage.

The output documents have the fields declared in the projection. Fields not declared are removed (except_id``).

If you want to only overwrite fields, use set instead. project is more verbose, but also more performant since it guarantees there are no left-over unused fields.

Using both project and set in the same $unwind is forbidden.

The benefit of using this method instead of manually declaring a subsequent projection is that this method receives the correctly-typed variable that contains the unwind result.

The field passed to array should not be used within the projection, as it has been unwound and thus doesn't store an array anymore: its type is incorrect within this stage.

Example

class User(
    val _id: ObjectId,
    val name: String,
    val pets: List<Pet>
)

class Pet(
    val name: String,
    val age: Int,
)

class Result(
    val userId: ObjectId,
    val userName: String,
    val petName: String,
    val petAge: Int,
)

users.aggregate()
    .unwind {
        array(User::pets)

        project {
            Result::userId set User::name
            Result::userName set User::name
            Result::petName set (it / Pet::name)
            Result::petAge set (it / Pet::age)
        }
    }

Example input:

User(/* … */, "Alice", listOf(Pet("Bob", 5), Pet("Charlie", 6)))
 User(/* … */, "Damian", listOf(Pet("Eva", 2)))

Output:

Result(/* … */, "Alice", "Bob", 5)
 Result(/* … */, "Alice", "Charlie", 6)
 Result(/* … */, "Damian", "Eva", 2)

`replace`¶

@JvmName(name = "replaceResultReceiverByResultByResult")
inline fun String?.replace(find: String?, replacement: String?): Value<Any, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByResultByProperty")
inline fun <Context : Any> String?.replace(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByResultByValue")
inline fun <Context : Any> String?.replace(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByResultByField")
inline fun <Context : Any> String?.replace(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByPropertyByResult")
inline fun <Context : Any> String?.replace(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByPropertyByProperty")
inline fun <Context : Any> String?.replace(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByPropertyByValue")
inline fun <Context : Any> String?.replace(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByPropertyByField")
inline fun <Context : Any> String?.replace(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByValueByResult")
inline fun <Context : Any> String?.replace(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByValueByProperty")
inline fun <Context : Any> String?.replace(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByValueByValue")
inline fun <Context : Any> String?.replace(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByValueByField")
inline fun <Context : Any> String?.replace(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByFieldByResult")
inline fun <Context : Any> String?.replace(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByFieldByProperty")
inline fun <Context : Any> String?.replace(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByFieldByValue")
inline fun <Context : Any> String?.replace(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceResultReceiverByFieldByField")
inline fun <Context : Any> String?.replace(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByResultByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replace(find: String?, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByResultByProperty")
inline fun <Context : Any> KProperty1<Context, String?>.replace(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByResultByValue")
inline fun <Context : Any> KProperty1<Context, String?>.replace(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByResultByField")
inline fun <Context : Any> KProperty1<Context, String?>.replace(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByPropertyByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByPropertyByProperty")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByPropertyByValue")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByPropertyByField")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByValueByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replace(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByValueByProperty")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByValueByValue")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByValueByField")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByFieldByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replace(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByFieldByProperty")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByFieldByValue")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replacePropertyReceiverByFieldByField")
open fun <Context : Any> KProperty1<Context, String?>.replace(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

inline fun <Context : Any> Value<Context, String?>.replace(find: String?, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByResultByProperty")
inline fun <Context : Any> Value<Context, String?>.replace(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

inline fun <Context : Any> Value<Context, String?>.replace(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByResultByField")
inline fun <Context : Any> Value<Context, String?>.replace(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByPropertyByResult")
inline fun <Context : Any> Value<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByPropertyByProperty")
open fun <Context : Any> Value<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByPropertyByValue")
open fun <Context : Any> Value<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByPropertyByField")
open fun <Context : Any> Value<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

inline fun <Context : Any> Value<Context, String?>.replace(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByValueByProperty")
open fun <Context : Any> Value<Context, String?>.replace(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

open fun <Context : Any> Value<Context, String?>.replace(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByValueByField")
open fun <Context : Any> Value<Context, String?>.replace(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByFieldByResult")
inline fun <Context : Any> Value<Context, String?>.replace(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByFieldByProperty")
open fun <Context : Any> Value<Context, String?>.replace(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByFieldByValue")
open fun <Context : Any> Value<Context, String?>.replace(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceByFieldByField")
open fun <Context : Any> Value<Context, String?>.replace(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByResultByResult")
inline fun <Context : Any> Field<Context, String?>.replace(find: String?, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByResultByProperty")
inline fun <Context : Any> Field<Context, String?>.replace(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByResultByValue")
inline fun <Context : Any> Field<Context, String?>.replace(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByResultByField")
inline fun <Context : Any> Field<Context, String?>.replace(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByPropertyByResult")
inline fun <Context : Any> Field<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByPropertyByProperty")
open fun <Context : Any> Field<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByPropertyByValue")
open fun <Context : Any> Field<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByPropertyByField")
open fun <Context : Any> Field<Context, String?>.replace(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByValueByResult")
inline fun <Context : Any> Field<Context, String?>.replace(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByValueByProperty")
open fun <Context : Any> Field<Context, String?>.replace(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByValueByValue")
open fun <Context : Any> Field<Context, String?>.replace(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByValueByField")
open fun <Context : Any> Field<Context, String?>.replace(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByFieldByResult")
inline fun <Context : Any> Field<Context, String?>.replace(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByFieldByProperty")
open fun <Context : Any> Field<Context, String?>.replace(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByFieldByValue")
open fun <Context : Any> Field<Context, String?>.replace(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

@JvmName(name = "replaceFieldReceiverByFieldByField")
open fun <Context : Any> Field<Context, String?>.replace(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces all instances of find with a replacement string.

`replaceFirst`¶

@JvmName(name = "replaceFirstResultReceiverByResultByResult")
inline fun String?.replaceFirst(find: String?, replacement: String?): Value<Any, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByResultByProperty")
inline fun <Context : Any> String?.replaceFirst(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByResultByValue")
inline fun <Context : Any> String?.replaceFirst(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByResultByField")
inline fun <Context : Any> String?.replaceFirst(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByPropertyByResult")
inline fun <Context : Any> String?.replaceFirst(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByPropertyByProperty")
inline fun <Context : Any> String?.replaceFirst(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByPropertyByValue")
inline fun <Context : Any> String?.replaceFirst(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByPropertyByField")
inline fun <Context : Any> String?.replaceFirst(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByValueByResult")
inline fun <Context : Any> String?.replaceFirst(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByValueByProperty")
inline fun <Context : Any> String?.replaceFirst(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByValueByValue")
inline fun <Context : Any> String?.replaceFirst(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByValueByField")
inline fun <Context : Any> String?.replaceFirst(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByFieldByResult")
inline fun <Context : Any> String?.replaceFirst(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByFieldByProperty")
inline fun <Context : Any> String?.replaceFirst(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByFieldByValue")
inline fun <Context : Any> String?.replaceFirst(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstResultReceiverByFieldByField")
inline fun <Context : Any> String?.replaceFirst(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByResultByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: String?, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByResultByProperty")
inline fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByResultByValue")
inline fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByResultByField")
inline fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByPropertyByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByPropertyByProperty")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByPropertyByValue")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByPropertyByField")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByValueByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByValueByProperty")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByValueByValue")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByValueByField")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByFieldByResult")
inline fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByFieldByProperty")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByFieldByValue")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstPropertyReceiverByFieldByField")
open fun <Context : Any> KProperty1<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

inline fun <Context : Any> Value<Context, String?>.replaceFirst(find: String?, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByResultByProperty")
inline fun <Context : Any> Value<Context, String?>.replaceFirst(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

inline fun <Context : Any> Value<Context, String?>.replaceFirst(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByResultByField")
inline fun <Context : Any> Value<Context, String?>.replaceFirst(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByPropertyByResult")
inline fun <Context : Any> Value<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByPropertyByProperty")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByPropertyByValue")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByPropertyByField")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

inline fun <Context : Any> Value<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByValueByProperty")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

open fun <Context : Any> Value<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByValueByField")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByFieldByResult")
inline fun <Context : Any> Value<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByFieldByProperty")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByFieldByValue")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstByFieldByField")
open fun <Context : Any> Value<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByResultByResult")
inline fun <Context : Any> Field<Context, String?>.replaceFirst(find: String?, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByResultByProperty")
inline fun <Context : Any> Field<Context, String?>.replaceFirst(find: String?, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByResultByValue")
inline fun <Context : Any> Field<Context, String?>.replaceFirst(find: String?, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByResultByField")
inline fun <Context : Any> Field<Context, String?>.replaceFirst(find: String?, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByPropertyByResult")
inline fun <Context : Any> Field<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByPropertyByProperty")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByPropertyByValue")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByPropertyByField")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: KProperty1<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByValueByResult")
inline fun <Context : Any> Field<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByValueByProperty")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByValueByValue")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByValueByField")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: Value<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByFieldByResult")
inline fun <Context : Any> Field<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: String?): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByFieldByProperty")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: KProperty1<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByFieldByValue")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: Value<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

@JvmName(name = "replaceFirstFieldReceiverByFieldByField")
open fun <Context : Any> Field<Context, String?>.replaceFirst(find: Field<Context, String?>, replacement: Field<Context, String?>): Value<Context, String?>

Replaces the first instance of find with a replacement string.

set¶

abstract fun set(block: SetStageOperators<In, Out>.(item: Value<In, Item?>) -> Unit)

Immediately declares a $set stage that follows this $unwind stage.

The output documents have the same fields as the initial documents, except that $set may overwrite some fields.

If you want to create and remove fields, use project instead. project is more verbose, but also more performant since it guarantees there are no left-over unused fields.

Using both project and set in the same $unwind is forbidden.

The benefit of using this method instead of manually declaring a subsequent projection is that this method receives the correctly-typed variable that contains the unwind result.

The field passed to array should not be used within the projection, as it has been unwound and thus doesn't store an array anymore: its type is incorrect within this stage.

Example

class User(
    val _id: ObjectId,
    val name: String,
    val pets: List<Pet>
)

class Pet(
    val name: String,
    val age: Int,
)

class Result(
    // Fields from 'User'
    val _id: ObjectId,
    val name: String,

    // A single pet
    val pet: Pet,
)

users.aggregate()
    .unwind {
        array(User::pets)

        set {
            Result::pet set it
        }
    }

Example input:

User(/* … */, "Alice", listOf(Pet("Bob", 5), Pet("Charlie", 6)))
 User(/* … */, "Damian", listOf(Pet("Eva", 2)))

Output:

Result(/* … */, "Alice", "Bob", 5)
 Result(/* … */, "Alice", "Charlie", 6)
 Result(/* … */, "Damian", "Eva", 2)

`simplify`¶

@LowLevelApi
abstract fun simplify(): BsonNode?

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

`sin`¶

@JvmName(name = "sinNonNull")
inline fun sin(value: Double): Value<Any, Double>

The sine of a value that is measured in radians.

inline fun sin(value: Double?): Value<Any, Double?>

The sine of a value that is measured in radians.

@JvmName(name = "sinByProperty")
open fun <Context : Any> sin(value: KProperty1<Context, Double?>): Value<Context, Double?>

The sine of a value that is measured in radians.

@JvmName(name = "sinNonNullByProperty")
fun <Context : Any> sin(value: KProperty1<Context, Double>): Value<Context, Double>

The sine of a value that is measured in radians.

open fun <Context : Any> sin(value: Value<Context, Double?>): Value<Context, Double?>

The sine of a value that is measured in radians.

@JvmName(name = "sinNonNull")
fun <Context : Any> sin(value: Value<Context, Double>): Value<Context, Double>

The sine of a value that is measured in radians.

@JvmName(name = "sinByField")
open fun <Context : Any> sin(value: Field<Context, Double?>): Value<Context, Double?>

The sine of a value that is measured in radians.

@JvmName(name = "sinNonNullByField")
fun <Context : Any> sin(value: Field<Context, Double>): Value<Context, Double>

The sine of a value that is measured in radians.

`sinh`¶

@JvmName(name = "sinhNonNull")
inline fun sinh(value: Double): Value<Any, Double>

The hyperbolic sine of a value that is measured in radians.

inline fun sinh(value: Double?): Value<Any, Double?>

The hyperbolic sine of a value that is measured in radians.

@JvmName(name = "sinhByProperty")
open fun <Context : Any> sinh(value: KProperty1<Context, Double?>): Value<Context, Double?>

The hyperbolic sine of a value that is measured in radians.

@JvmName(name = "sinhNonNullByProperty")
fun <Context : Any> sinh(value: KProperty1<Context, Double>): Value<Context, Double>

The hyperbolic sine of a value that is measured in radians.

open fun <Context : Any> sinh(value: Value<Context, Double?>): Value<Context, Double?>

The hyperbolic sine of a value that is measured in radians.

@JvmName(name = "sinhNonNull")
fun <Context : Any> sinh(value: Value<Context, Double>): Value<Context, Double>

The hyperbolic sine of a value that is measured in radians.

@JvmName(name = "sinhByField")
open fun <Context : Any> sinh(value: Field<Context, Double?>): Value<Context, Double?>

The hyperbolic sine of a value that is measured in radians.

@JvmName(name = "sinhNonNullByField")
fun <Context : Any> sinh(value: Field<Context, Double>): Value<Context, Double>

The hyperbolic sine of a value that is measured in radians.

`sorted`¶

@JvmName(name = "sortedResultReceiver")
open fun <Context : Any, T> Collection<T>.sorted(): Value<Context, List<T>>

Sorts an array based on its elements, in ascending order.

@JvmName(name = "sortedPropertyReceiver")
open fun <Context : Any, T> KProperty1<Context, Collection<T>>.sorted(): Value<Context, List<T>>

Sorts an array based on its elements, in ascending order.

open fun <Context : Any, T> Value<Context, Collection<T>>.sorted(): Value<Context, List<T>>

Sorts an array based on its elements, in ascending order.

@JvmName(name = "sortedFieldReceiver")
open fun <Context : Any, T> Field<Context, Collection<T>>.sorted(): Value<Context, List<T>>

Sorts an array based on its elements, in ascending order.

`sortedBy`¶

@JvmName(name = "sortedByResultReceiver")
open fun <Context : Any, T> Collection<T>.sortedBy(order: SortOptionDsl<T & Any>.() -> Unit): Value<Context, List<T>>

Sorts an array based on fields of its elements.

@JvmName(name = "sortedByPropertyReceiver")
open fun <Context : Any, T> KProperty1<Context, Collection<T>>.sortedBy(order: SortOptionDsl<T & Any>.() -> Unit): Value<Context, List<T>>

Sorts an array based on fields of its elements.

open fun <Context : Any, T> Value<Context, Collection<T>>.sortedBy(order: SortOptionDsl<T & Any>.() -> Unit): Value<Context, List<T>>

Sorts an array based on fields of its elements.

@JvmName(name = "sortedByFieldReceiver")
open fun <Context : Any, T> Field<Context, Collection<T>>.sortedBy(order: SortOptionDsl<T & Any>.() -> Unit): Value<Context, List<T>>

Sorts an array based on fields of its elements.

`sortedDescending`¶

@JvmName(name = "sortedDescendingResultReceiver")
open fun <Context : Any, T> Collection<T>.sortedDescending(): Value<Context, List<T>>

Sorts an array based on its elements, in descending order.

@JvmName(name = "sortedDescendingPropertyReceiver")
open fun <Context : Any, T> KProperty1<Context, Collection<T>>.sortedDescending(): Value<Context, List<T>>

Sorts an array based on its elements, in descending order.

open fun <Context : Any, T> Value<Context, Collection<T>>.sortedDescending(): Value<Context, List<T>>

Sorts an array based on its elements, in descending order.

@JvmName(name = "sortedDescendingFieldReceiver")
open fun <Context : Any, T> Field<Context, Collection<T>>.sortedDescending(): Value<Context, List<T>>

Sorts an array based on its elements, in descending order.

`split`¶

@JvmName(name = "splitResultReceiverByResult")
inline fun String.split(delimiter: String): Value<Any, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitResultReceiverByProperty")
inline fun <Context : Any> String.split(delimiter: KProperty1<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitResultReceiverByValue")
inline fun <Context : Any> String.split(delimiter: Value<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitResultReceiverByField")
inline fun <Context : Any> String.split(delimiter: Field<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitPropertyReceiverByResult")
inline fun <Context : Any> KProperty1<Context, String>.split(delimiter: String): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitPropertyReceiverByProperty")
open fun <Context : Any> KProperty1<Context, String>.split(delimiter: KProperty1<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitPropertyReceiverByValue")
open fun <Context : Any> KProperty1<Context, String>.split(delimiter: Value<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitPropertyReceiverByField")
open fun <Context : Any> KProperty1<Context, String>.split(delimiter: Field<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

inline fun <Context : Any> Value<Context, String>.split(delimiter: String): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitByProperty")
open fun <Context : Any> Value<Context, String>.split(delimiter: KProperty1<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

open fun <Context : Any> Value<Context, String>.split(delimiter: Value<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitByField")
open fun <Context : Any> Value<Context, String>.split(delimiter: Field<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitFieldReceiverByResult")
inline fun <Context : Any> Field<Context, String>.split(delimiter: String): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitFieldReceiverByProperty")
open fun <Context : Any> Field<Context, String>.split(delimiter: KProperty1<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitFieldReceiverByValue")
open fun <Context : Any> Field<Context, String>.split(delimiter: Value<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.

@JvmName(name = "splitFieldReceiverByField")
open fun <Context : Any> Field<Context, String>.split(delimiter: Field<Context, String>): Value<Context, List<String>>

Divides a string into an array of substrings based on a delimiter.