com.mongodb

Class BulkWriteRequestBuilder

java.lang.Object

com.mongodb.BulkWriteRequestBuilder

public class BulkWriteRequestBuilder
extends java.lang.Object

A builder for a single write request.

Since:

2.12

Method Summary

Modifier and Type	Method and Description
BulkUpdateRequestBuilder	arrayFilters(java.util.List<? extends DBObject> arrayFilters) Specifies that the request being built should use the given array filters for an update.
BulkWriteRequestBuilder	collation(Collation collation) Sets the collation
Collation	getCollation() Returns the collation
void	remove() Adds a request to remove all documents in the collection that match the query with which this builder was created.
void	removeOne() Adds a request to remove one document in the collection that matches the query with which this builder was created.
void	replaceOne(DBObject document) Adds a request to replace one document in the collection that matches the query with which this builder was created.
void	update(DBObject update) Adds a request to update all documents in the collection that match the query with which this builder was created.
void	updateOne(DBObject update) Adds a request to update one document in the collection that matches the query with which this builder was created.
BulkUpdateRequestBuilder	upsert() Specifies that the request being built should be an upsert.

Methods inherited from class java.lang.Object

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

Method Detail

getCollation

@Nullable
public Collation getCollation()

Returns the collation

Returns:

the collation

Since:

3.4

collation

@Nullable
public BulkWriteRequestBuilder collation(Collation collation)

Sets the collation

Parameters:

collation - the collation

Returns:

this

Since:

3.4

remove

public void remove()

Adds a request to remove all documents in the collection that match the query with which this builder was created.

removeOne

public void removeOne()

Adds a request to remove one document in the collection that matches the query with which this builder was created.

replaceOne

public void replaceOne(DBObject document)

Adds a request to replace one document in the collection that matches the query with which this builder was created.

Parameters:

document - the replacement document, which must be structured just as a document you would insert. It can not contain any update operators.

update

public void update(DBObject update)

Adds a request to update all documents in the collection that match the query with which this builder was created.

Parameters:

update - the update criteria

updateOne

public void updateOne(DBObject update)

Adds a request to update one document in the collection that matches the query with which this builder was created.

Parameters:

update - the update criteria

upsert

public BulkUpdateRequestBuilder upsert()

Specifies that the request being built should be an upsert.

Returns:

a new builder that allows only update and replace, since upsert does not apply to remove.

arrayFilters

public BulkUpdateRequestBuilder arrayFilters(java.util.List<? extends DBObject> arrayFilters)

Specifies that the request being built should use the given array filters for an update. Note that this option only applies to update operations and will be ignored for replace operations

Parameters:

arrayFilters - the array filters to apply to the update operation

Returns:

a new builder that allows only update and replace, since upsert does not apply to remove.

Since:

3.6