Skip to content

MongoDB request DSLopensavvy.ktmongo.dsl.optionsSortOption

SortOption

class SortOption<Document : Any>(config: SortOptionDsl<Document>, val context: ) : AbstractCompoundOption

Describes in which order elements should be returned.

For more information, see WithSort.sort.

External resources

Constructors

SortOption

constructor(config: SortOptionDsl<Document>, context: )

Properties

block

val block: 

The sort option's configured block.

context

open override val context: 

The context used to generate this expression.

name

open override val name: String

The name of this option, as it appears in the BSON representation.

Functions

freeze

open override fun freeze()

Makes this node immutable.

read

override fun read(): 

Reads the value of this option.

simplify

override fun simplify(): AbstractBsonNode?

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

toBson

open fun toBson(): 

Writes the result of simplifying to a new Bson.

toString

override fun toString(): String

JSON representation of this expression.

fun toString(simplified: Boolean): String

JSON representation of this expression.

writeTo

override fun writeTo(writer: )

Writes the result of simplifying this expression into writer.