com.mongodb

Class BulkWriteOperation

java.lang.Object

com.mongodb.BulkWriteOperation

public class BulkWriteOperation
extends java.lang.Object

A bulk write operation. A bulk write operation consists of an ordered or unordered collection of write requests, which can be any combination of inserts, updates, replaces, or removes.

Since:

2.12

See Also:

DBCollection.initializeOrderedBulkOperation(), DBCollection.initializeUnorderedBulkOperation()

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Boolean	bypassDocumentValidation
private boolean	closed
private DBCollection	collection
private static java.lang.String	ID_FIELD_NAME
private boolean	ordered
private java.util.List<WriteRequest>	requests

Constructor Summary

Constructors

Constructor and Description
BulkWriteOperation(boolean ordered, DBCollection collection)

Method Summary

Modifier and Type	Method and Description
(package private) void	addRequest(WriteRequest request)
BulkWriteResult	execute() Execute the bulk write operation with the default write concern of the collection from which this came.
BulkWriteResult	execute(WriteConcern writeConcern) Execute the bulk write operation with the given write concern.
BulkWriteRequestBuilder	find(DBObject query) Start building a write request to add to the bulk write operation.
java.lang.Boolean	getBypassDocumentValidation() Gets whether to bypass document validation, or null if unspecified.
void	insert(DBObject document) Add an insert request to the bulk operation
boolean	isOrdered() Returns true if this is building an ordered bulk write request.
void	setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation) Sets whether to bypass document validation.

Methods inherited from class java.lang.Object

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

Field Detail

ID_FIELD_NAME

private static final java.lang.String ID_FIELD_NAME

See Also:

Constant Field Values

ordered

private final boolean ordered

collection

private final DBCollection collection

requests

private final java.util.List<WriteRequest> requests

bypassDocumentValidation

private java.lang.Boolean bypassDocumentValidation

closed

private boolean closed

Constructor Detail

BulkWriteOperation

BulkWriteOperation(boolean ordered,
                   DBCollection collection)

Method Detail

isOrdered

public boolean isOrdered()

Returns true if this is building an ordered bulk write request.

Returns:

whether this is building an ordered bulk write operation

See Also:

DBCollection.initializeOrderedBulkOperation(), DBCollection.initializeUnorderedBulkOperation()

getBypassDocumentValidation

public java.lang.Boolean getBypassDocumentValidation()

Gets whether to bypass document validation, or null if unspecified. The default is null.

Returns:

whether to bypass document validation, or null if unspecified.

Since:

2.14

setBypassDocumentValidation

public void setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)

Sets whether to bypass document validation.

Parameters:

bypassDocumentValidation - whether to bypass document validation, or null if unspecified

Since:

2.14

insert

public void insert(DBObject document)

Add an insert request to the bulk operation

Parameters:

document - the document to insert

find

public BulkWriteRequestBuilder find(DBObject query)

Start building a write request to add to the bulk write operation. The returned builder can be used to create an update, replace, or remove request with the given query.

Parameters:

query - the query for an update, replace or remove request

Returns:

a builder for a single write request

execute

public BulkWriteResult execute()

Execute the bulk write operation with the default write concern of the collection from which this came. Note that the continueOnError property of the write concern is ignored.

Returns:

the result of the bulk write operation.

Throws:

BulkWriteException - if the write failed due some other failure specific to the write command

MongoException - if the operation failed for some other reason

execute

public BulkWriteResult execute(WriteConcern writeConcern)

Execute the bulk write operation with the given write concern. Note that the continueOnError property of the write concern is ignored.

Parameters:

writeConcern - the write concern to apply to the bulk operation.

Returns:

the result of the bulk write operation.

Throws:

BulkWriteException - if the write failed due some other failure specific to the write command

MongoException - if the operation failed for some other reason

addRequest

void addRequest(WriteRequest request)