KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.command/UpdateOptions

UpdateOptions

class UpdateOptions<Document>(context: BsonContext) : Options, WithWriteConcern, WithArrayFilters(source)

The options for a UpdateOne, UpsertOne, UpdateMany operation.

Constructors

UpdateOptions

constructor(context: BsonContext)

Properties

allOptions

@LowLevelApi

open override val allOptions: List<Option>

The full list of options set on this container.

context

@LowLevelApi

open override val context: BsonContext

The context used to generate this expression.

Functions

@LowLevelApi

@DangerousMongoApi

open 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.

arrayFilter

open fun <Item> arrayFilter(id: String, filter: ArrayFiltersOptionDsl<Item>.(it: Field<ArrayFiltersOptionDsl.IteratorType<Item>, Item>) -> Unit)

Declares an array filter, which can then be passed to UpdateQuery.filter.

freeze

@LowLevelApi

open 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

open override fun simplify(): BsonNode?

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

toBson

@LowLevelApi

open override fun toBson(): BsonDocument

Writes the result of simplifying to a new BsonDocument.

toString

open override fun toString(): String

JSON representation of this option.

writeConcern

open fun writeConcern(concern: WriteConcern)

Specifies the WriteConcern for this operation.

writeTo

@LowLevelApi

open override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.