Package com.mongodb.bulk

Class UpdateRequest

java.lang.Object

com.mongodb.bulk.WriteRequest

com.mongodb.bulk.UpdateRequest

public final class UpdateRequest
extends WriteRequest

An update to one or more documents.

Since:

3.0

Nested Class Summary

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

WriteRequest.Type

Constructor Summary

Constructors

Constructor	Description
UpdateRequest(BsonDocument filter, BsonDocument update, WriteRequest.Type updateType)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
UpdateRequest	arrayFilters(List<BsonDocument> arrayFilters)	Sets the array filters option
UpdateRequest	collation(Collation collation)	Sets the collation options
List<BsonDocument>	getArrayFilters()	Returns the array filters option
Collation	getCollation()	Returns the collation options
BsonDocument	getFilter()	Gets the query filter for the update.
WriteRequest.Type	getType()	Gets the type of the write.
BsonDocument	getUpdate()	Gets the update.
boolean	isMulti()	Gets whether this update will update all documents matching the filter.
boolean	isUpsert()	Gets whether this update will insert a new document if no documents match the filter.
UpdateRequest	multi(boolean isMulti)	Sets whether this will update all documents matching the query filter.
UpdateRequest	upsert(boolean isUpsert)	Sets whether this update will insert a new document if no documents match the filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateRequest

public UpdateRequest(BsonDocument filter,
                     BsonDocument update,
                     WriteRequest.Type updateType)

Construct a new instance.

Parameters:

filter - the non-null query filter

update - the non-null update operations

updateType - the update type, which must be either UPDATE or REPLACE

Method Detail

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

getFilter

public BsonDocument getFilter()

Gets the query filter for the update.

Returns:

the filter

getUpdate

public BsonDocument getUpdate()

Gets the update.

Returns:

the update

isMulti

public boolean isMulti()

Gets whether this update will update all documents matching the filter. The default is true.

Returns:

whether this update will update all documents matching the filter

multi

public UpdateRequest multi(boolean isMulti)

Sets whether this will update all documents matching the query filter.

Parameters:

isMulti - whether this will update all documents matching the query filter

Returns:

this

isUpsert

public boolean isUpsert()

Gets whether this update will insert a new document if no documents match the filter. The default is false.

Returns:

whether this update will insert a new document if no documents match the filter

upsert

public UpdateRequest upsert(boolean isUpsert)

Sets whether this update will insert a new document if no documents match the filter.

Parameters:

isUpsert - whether this update will insert a new document if no documents match the filter

Returns:

this

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public UpdateRequest 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

arrayFilters

public UpdateRequest arrayFilters(List<BsonDocument> arrayFilters)

Sets the array filters option

Parameters:

arrayFilters - the array filters, which may be null

Returns:

this

Since:

3.6

Since server release

3.6

getArrayFilters

public List<BsonDocument> getArrayFilters()

Returns the array filters option

Returns:

the array filters, which may be null

Since:

3.6

Since server release

3.6