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

Options

interface Options : CompoundBsonNode(source)

Parent interface for all option containers.

Option containers are types that declare a set of options. They are usually tied to a specific MongoDB command.

For example, for options related to the Count command, see CountOptions.

Inheritors

Properties

allOptions

@LowLevelApi

abstract val allOptions: List<Option>

The full list of options set on this container.

context

@LowLevelApi

abstract val context: BsonContext

The context used to generate this expression.

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.

freeze

@LowLevelApi

abstract override fun freeze()

Makes this expression immutable.

option

@LowLevelApi

inline fun <O : Option> Options.option(): O?

Accesses the value of a given Option.

simplify

@LowLevelApi

abstract fun simplify(): BsonNode?

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

toBson

@LowLevelApi

open fun toBson(): Bson

Writes the result of simplifying to a new BSON document.

toString

abstract override fun toString(): String

JSON representation of this option.

writeTo

@LowLevelApi

abstract override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.