MongoDB request DSL • opensavvy.ktmongo.dsl.options • Options

Options

interface Options : CompoundBsonNode

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

• BulkWriteOptions
• CountOptions
• DeleteOneOptions
• DeleteManyOptions
• DropOptions
• FindOptions
• InsertOneOptions
• InsertManyOptions
• UpdateOptions
• WithLimit
• WithMaxTime
• WithReadConcern
• WithReadPreference
• WithSkip
• WithSort
• WithWriteConcern

Properties

allOptions

abstract val allOptions: List<Option>

The full list of options set on this container.

context

abstract val context: 

The context used to generate this expression.

Functions

accept

abstract override fun accept(node: BsonNode)

Adds a new node as a child of this one.

acceptAll

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

Adds any number of nodes into this one.

freeze

abstract override fun freeze()

Makes this expression immutable.

option

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

Accesses the value of a given Option.

simplify

abstract fun simplify(): BsonNode?

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

toBson

open fun toBson(): 

Writes the result of simplifying to a new Bson.

toString

abstract override fun toString(): String

JSON representation of this option.

writeTo

abstract fun writeTo(writer: )

Writes the result of simplifying this expression into writer.