KtMongo: MongoDB driver for Kotlin • API/opensavvy.ktmongo.api.operations/UpdatePipelineOperations

UpdatePipelineOperations

interface UpdatePipelineOperations<Document : Any> : BaseOperations(source)

Interface grouping MongoDB operations allowing to update existing information using aggregation pipelines.

Inheritors

MongoCollection

Properties

abstract val context: BsonContext

The full BSON configuration, used by the DSL to generate queries.

Functions

updateManyWithPipeline

@IgnorableReturnValue

abstract suspend fun updateManyWithPipeline(options: UpdateOptions<Document>.() -> Unit = {}, filter: FilterQuery<Document>.() -> Unit = {}, update: UpdateWithPipelineQuery<Document>.() -> Unit): UpdateOperations.UpdateResult

Updates all documents that match filter according to the update pipeline.

updateOneWithPipeline

@IgnorableReturnValue

abstract suspend fun updateOneWithPipeline(options: UpdateOptions<Document>.() -> Unit = {}, filter: FilterQuery<Document>.() -> Unit = {}, update: UpdateWithPipelineQuery<Document>.() -> Unit): UpdateOperations.UpdateResult

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

upsertOneWithPipeline

@IgnorableReturnValue

abstract suspend fun upsertOneWithPipeline(options: UpdateOptions<Document>.() -> Unit = {}, filter: FilterQuery<Document>.() -> Unit = {}, update: UpdateWithPipelineQuery<Document>.() -> Unit): UpdateOperations.UpsertResult

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