kmongo / org.litote.kmongo / com.mongodb.client.MongoCollection / deleteOne

deleteOne

fun <T> MongoCollection<T>.deleteOne(filter: String): DeleteResult (source)

Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified.

Parameters

filter - the query filter to apply the the delete operation

Exceptions

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

Return
the result of the remove one operation

fun <T> MongoCollection<T>.deleteOne(vararg filters: Bson?): DeleteResult (source)

Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified.

Parameters

filters - the query filters to apply the the delete operation

Exceptions

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

Return
the result of the remove one operation

fun <T> MongoCollection<T>.deleteOne(clientSession: ClientSession, filter: String): DeleteResult (source)

Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified.

Parameters

clientSession - the client session with which to associate this operation

filter - the query filter to apply the the delete operation

Exceptions

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

Return
the result of the remove one operation

fun <T> MongoCollection<T>.deleteOne(clientSession: ClientSession, vararg filters: Bson?): DeleteResult (source)

Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified.

Parameters

clientSession - the client session with which to associate this operation

filters - the query filters to apply the the delete operation

Exceptions

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

Return
the result of the remove one operation