KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.query/UpdateQuery/PushSortDsl

PushSortDsl

interface PushSortDsl<V : Any> : SortOptionDsl<V> (source)

DSL for sorting elements during a $push operation.

See push and PushBuilder.sort.

Properties

context

@LowLevelApi

abstract val context: BsonContext

The context used to generate this expression.

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.

ascending

open fun ascending(field: KProperty1<V, *>)

abstract fun ascending(field: Field<V, *>)

If two documents have a different value of field, the one with lesser value will be returned first.

abstract fun ascending()

Sort array elements in ascending order (for simple values, not documents).

descending

open fun descending(field: KProperty1<V, *>)

abstract fun descending(field: Field<V, *>)

If two documents have a different value of field, the one with greater value will be returned first.

abstract fun descending()

Sort array elements in descending order (for simple values, not documents).

div

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.

simplify

@LowLevelApi

abstract fun simplify(): BsonNode?

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

toBson

@LowLevelApi

open fun toBson(): BsonDocument

Writes the result of simplifying to a new BsonDocument.

toString

abstract override fun toString(): String

JSON representation of this expression.

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.