MongoDB request DSL/opensavvy.ktmongo.dsl.aggregation/UpdatePipeline

UpdatePipeline

interface UpdatePipeline<Document : Any> : Pipeline<Document> , HasProject<Document> , HasSet<Document> , HasUnset<Document> (source)

An update pipeline.

Update pipelines allow more complex updates directly through the various update functions.

Example

users.updateManyWithPipeline {
    set {
        User::score set (of(User::score) + (of(User::scoreMultiplier) * of(User::dailyScore)))
        User::dailyScore set 0
    }
}

External resources

Official documentation

Properties

context

abstract val context: <Error class: unknown class>

The context used to generate this pipeline.

Functions

project

open fun project(block: ProjectStageOperators<Document>.() -> Unit): Pipeline<Document>

Specifies a list of fields which should be kept in the document.

reinterpret

abstract fun <New : Any> reinterpret(): Pipeline<New>

Changes the type of the returned document, with no type-safety.

set

open fun set(block: SetStageOperators<Document>.() -> Unit): Pipeline<Document>

Adds new fields to documents, or overwrites existing fields.

toString

abstract override fun toString(): String

JSON representation of this pipeline.

unset

open fun unset(block: UnsetStageOperators<Document>.() -> Unit): Pipeline<Document>

Removes fields from documents.

withStage

abstract fun withStage(stage: BsonNode): Pipeline<Document>

Creates a new pipeline that expands on the current one by adding stage.

writeTo

abstract fun writeTo(writer: <Error class: unknown class>)

Writes the entire pipeline into writer.