MongoDB driver for Kotlin (synchronous) • opensavvy.ktmongo.sync • JvmMongoCollection • updateOneWithPipeline

updateOneWithPipeline

open override fun updateOneWithPipeline(options: UpdateOptions<Document>.() -> Unit, filter: FilterQuery<Document>.() -> Unit, update: UpdateWithPipelineQuery<Document>.() -> Unit)

Updates a single document that matches filter according to the update pipeline.

If multiple documents match filter, only the first one found is updated.

Example

class User(
    val name: String,
    val age: Int,
)

collection.updateOneWithPipeline(
    filter = {
        User::name eq "Patrick"
    }
) {
    set {
        User::age set 15
    }
}

External resources

• Official documentation

Parameters

filter

Optional filter to select which document is updated. If no filter is specified, the first document found is updated.

See also

• JvmMongoCollection.updateManyWithPipeline Update multiple documents.

• JvmMongoCollection.upsertOneWithPipeline Update a document, creating it if it doesn't exist.