KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.options/SortOption

SortOption

class SortOption<Document : Any> : AbstractCompoundOption(source)

Describes in which order elements should be returned.

For more information, see WithSort.sort.

External resources

Official documentation

Constructors

SortOption

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

Properties

block

val block: BsonDocument

The sort option's configured block.

context

@LowLevelApi

open override val context: BsonContext

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

@LowLevelApi

open override fun freeze()

Makes this node immutable.

merge

@LowLevelApi

open override fun merge(other: Option): Option

Merges this option with another of the same type.

read

@LowLevelApi

override fun read(): BsonValue

Reads the value of this option.

simplify

@LowLevelApi

override fun simplify(): AbstractBsonNode?

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

override fun toString(): String

fun toString(simplified: Boolean): String

JSON representation of this expression.

writeTo

@LowLevelApi

override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.