updateOne

abstract fun updateOne(options: <Error class: unknown class><Document>.() -> Unit = {}, filter: <Error class: unknown class><Document>.() -> Unit = {}, update: <Error class: unknown class><Document>.() -> Unit)(source)

Updates a single document that matches filter according to update.

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

Example

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

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

Using filtered collections

The following code is equivalent:

collection.filter {
User::name eq "Patrick"
}.updateOne {
User::age set 15
}

To learn more, see filter.

External resources

Parameters

filter

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

See also

Update more than one document.

Also returns the result of the update.