Package com.mongodb.bulk

Class DeleteRequest

java.lang.Object

com.mongodb.bulk.WriteRequest

com.mongodb.bulk.DeleteRequest

public final class DeleteRequest
extends WriteRequest

A representation of a delete.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class com.mongodb.bulk.WriteRequest

WriteRequest.Type

Constructor Summary

Constructors

Constructor	Description
DeleteRequest(BsonDocument filter)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
DeleteRequest	collation(Collation collation)	Sets the collation options
Collation	getCollation()	Returns the collation options
BsonDocument	getFilter()	Gets the query Object filter.
WriteRequest.Type	getType()	Gets the type of the write.
boolean	isMulti()	Gets whether all documents matching the query filter will be removed.
DeleteRequest	multi(boolean isMulti)	Sets whether all documents matching the query filter will be removed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeleteRequest

public DeleteRequest(BsonDocument filter)

Construct a new instance.

Parameters:

filter - the non-null query filter

Method Detail

getFilter

public BsonDocument getFilter()

Gets the query Object filter.

Returns:

the Object filter

multi

public DeleteRequest multi(boolean isMulti)

Sets whether all documents matching the query filter will be removed.

Parameters:

isMulti - true if all documents matching the query filter will be removed

Returns:

this

isMulti

public boolean isMulti()

Gets whether all documents matching the query filter will be removed. The default is true.

Returns:

whether all documents matching the query filter will be removed

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public DeleteRequest collation(Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

3.4

Since server release

3.4

getType

public WriteRequest.Type getType()

Description copied from class: WriteRequest

Gets the type of the write.

Specified by:

getType in class WriteRequest

Returns:

the type