DeleteOne

class DeleteOne<Document : Any> : AbstractBsonNode, Command, AvailableInBulkWrite<Document> 

Deleting a single document from a collection.

Example

users.deleteOne {
    User::name eq "Patrick"
}

External resources

• Official documentation

Constructors

DeleteOne

constructor(context: BsonContext)

Properties

context

@LowLevelApi



open override val context: BsonContext

The context used to generate this expression.

filter

val filter: FilterQuery<Document>

options

val options: DeleteOneOptions<Document>

Functions

freeze

@LowLevelApi



open override fun freeze()

Makes this node immutable.

simplify

@LowLevelApi



open override fun simplify(): AbstractBsonNode?

Returns a simplified (but equivalent) expression to the current expression.

toBson

@LowLevelApi



open fun toBson(): Bson

Writes the result of simplifying to a new BSON document.

toString

override fun toString(): String

JSON representation of this expression.

fun toString(simplified: Boolean): String

JSON representation of this expression.

writeTo

@LowLevelApi



override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.