KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.aggregation.accumulators/ArithmeticValueAccumulators

ArithmeticValueAccumulators

interface ArithmeticValueAccumulators<From : Any, Into : Any> : ValueAccumulators<From, Into> (source)

Accumulators to perform arithmetic operations.

To learn more about accumulation operators, see AccumulationOperators.

Inheritors

AccumulationOperators

Properties

context

@LowLevelApi

abstract override val context: BsonContext

The strategy used when converting from KProperty1 to Field.

field

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

Converts a Kotlin property into a Field.

Functions

@LowLevelApi

@DangerousMongoApi

abstract override fun accept(node: BsonNode)

Adds a new node as a child of this one.

acceptAll

@LowLevelApi

@DangerousMongoApi

fun <N : Node> CompoundNode<N>.acceptAll(nodes: Iterable<N>)

Adds any number of nodes into this one.

average

open infix fun <T : Number> KProperty1<Into, T>.average(value: Value<From, Number?>)

open infix fun <T : Number> Field<Into, T>.average(value: Value<From, Number?>)

Calculates and returns the collective average of numeric values. Non-numeric values are ignored.

div

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

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>

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

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

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

freeze

@LowLevelApi

abstract override fun freeze()

Makes this expression immutable.

get

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

open operator fun <Root, Type> Field<Root, Collection<Type>>.get(index: Int): Field<Root, Type>

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

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

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

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

median

open infix fun <T : Number> KProperty1<Into, T>.median(value: Value<From, Number?>)

open infix fun <T : Number> Field<Into, T>.median(value: Value<From, Number?>)

Returns an approximation of the median, the 50th percentile, as a scalar value.

open 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>

open fun <Context : Any, Result> of(field: Field<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.

percentiles

open fun <T : Number> KProperty1<Into, List<T>>.percentiles(value: Value<From, Number?>, vararg percentiles: Double)

open fun <T : Number> Field<Into, List<T>>.percentiles(value: Value<From, Number?>, vararg percentiles: Double)

Returns an approximation of the specified percentiles.

simplify

@LowLevelApi

abstract fun simplify(): BsonNode?

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

sum

open infix fun <T : Number> KProperty1<Into, T>.sum(value: Value<From, Number?>)

open infix fun <T : Number> Field<Into, T>.sum(value: Value<From, Number?>)

Calculates and returns the collective sum of numeric values. Non-numeric values are ignored.

toBson

@LowLevelApi

open fun toBson(): Bson

Writes the result of simplifying to a new BSON document.

unsafe

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

open infix fun <Root, Type, Child> Field<Root, Type>.unsafe(child: String): Field<Root, Child>

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

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

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

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

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

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

writeTo

@LowLevelApi

abstract override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.