com.allanbank.mongodb.builder

Class BatchedWrite

java.lang.Object

com.allanbank.mongodb.builder.BatchedWrite

All Implemented Interfaces:

Serializable

public class BatchedWrite
extends Object
implements Serializable

BatchedWrite provides a container for a group of write operations to be sent to the server as one group.

The default mode (BatchedWriteMode.SERIALIZE_AND_CONTINUE) for this class is to submit the operations to the server in the order that they are added to the Builder and to apply as many of the writes as possible (commonly referred to as continue-on-error). This has the effect of causing the fewest surprises and optimizing the performance of the writes since the driver can send multiple distinct writes to the server at once.

The BatchedWriteMode.SERIALIZE_AND_STOP mode also sends each write as a separate request but instead of attempting all writes the driver will stop sending requests once one of the writes fails. This also prevents the driver from sending multiple write messages to the server which can degrade performance.

The last mode, BatchedWriteMode.REORDERED, may re-order writes to maximize performance. Similar to the BatchedWriteMode.SERIALIZE_AND_CONTINUE this mode will also attempt all writes. The reordering of writes is across all WriteOperationType s.

If using a MongoDB server after 2.5.5 a batched write will result in use of the new write commands.

For a more generalized batched write and query capability see the BatchedAsyncMongoCollection and MongoCollection.startBatch().

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchedWrite.Builder Builder for creating BatchedWrites.
static class	BatchedWrite.Bundle Bundle is a container for the write command and the WriteOperation it contains.

Field Summary

Fields

Modifier and Type	Field and Description
static Version	REQUIRED_VERSION The first version of MongoDB to support the aggregate command.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BatchedWrite(BatchedWrite.Builder builder) Creates a new BatchedWrite.

Method Summary

Methods

Modifier and Type	Method and Description
static BatchedWrite.Builder	builder() Creates a new builder for a BatchedWrite.
static BatchedWrite	delete(DocumentAssignable query, boolean singleDelete, Durability durability) Create a batched write with a single delete operation.
Durability	getDurability() Returns the durability for the writes.
BatchedWriteMode	getMode() Returns the mode for submitting the writes to the server.
List<WriteOperation>	getWrites() Returns the writes to submit to the server.
static BatchedWrite	insert(boolean continueOnError, Durability durability, DocumentAssignable... documents) Create a batched write with a single inserts operation.
List<BatchedWrite.Bundle>	toBundles(String collectionName, long maxCommandSize, int maxOperationsPerBundle) Creates write commands for all of the insert, updates and deletes.
static BatchedWrite	update(DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert, Durability durability) Create a batched write with a single update operation.

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_VERSION

public static final Version REQUIRED_VERSION

The first version of MongoDB to support the aggregate command.

Constructor Detail

BatchedWrite

protected BatchedWrite(BatchedWrite.Builder builder)

Creates a new BatchedWrite.

Parameters:

builder - The builder for the writes.

Method Detail

builder

public static BatchedWrite.Builder builder()

Creates a new builder for a BatchedWrite.

Returns:

The builder to construct a BatchedWrite.

delete

public static BatchedWrite delete(DocumentAssignable query,
                  boolean singleDelete,
                  Durability durability)

Create a batched write with a single delete operation. Users can just use the MongoCollection.delete(com.allanbank.mongodb.bson.DocumentAssignable) variants and the driver will convert the deletes to batched writes as appropriate.

This method avoids the construction of a builder.

Parameters:

query - The query to find the documents to delete.

singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.

durability - The durability of the delete.

Returns:

The BatchedWrite with the single delete.

insert

public static BatchedWrite insert(boolean continueOnError,
                  Durability durability,
                  DocumentAssignable... documents)

Create a batched write with a single inserts operation. Users can just use the MongoCollection.insert(boolean, com.allanbank.mongodb.bson.DocumentAssignable...) variants and the driver will convert the inserts to batched writes as appropriate.

This method avoids the construction of a builder.

Parameters:

continueOnError - If the insert should continue if one of the documents causes an error.

durability - The durability for the insert.

documents - The documents to add to the collection.

Returns:

The BatchedWrite with the inserts.

update

public static BatchedWrite update(DocumentAssignable query,
                  DocumentAssignable update,
                  boolean multiUpdate,
                  boolean upsert,
                  Durability durability)

Create a batched write with a single update operation. Users can just use the MongoCollection.update(com.allanbank.mongodb.bson.DocumentAssignable, com.allanbank.mongodb.bson.DocumentAssignable) variants and the driver will convert the updates to batched writes as appropriate.

Parameters:

query - The query for the update.

update - The update for the update.

multiUpdate - If true then the update will update multiple documents.

upsert - If no document is found then upsert the document.

durability - The durability of the update.

Returns:

The BatchedWrite with the single update.

getDurability

public Durability getDurability()

Returns the durability for the writes.

Returns:

The durability for the writes.

getMode

public BatchedWriteMode getMode()

Returns the mode for submitting the writes to the server.

Returns:

The mode for submitting the writes to the server.

getWrites

public List<WriteOperation> getWrites()

Returns the writes to submit to the server.

Returns:

The writes to submit to the server.

toBundles

public List<BatchedWrite.Bundle> toBundles(String collectionName,
                                  long maxCommandSize,
                                  int maxOperationsPerBundle)

Creates write commands for all of the insert, updates and deletes. The number and order of the writes is based on the mode.

Parameters:

collectionName - The name of the collection the documents will be inserted into.

maxCommandSize - The maximum document size.

maxOperationsPerBundle - The maximum number of writes to include in each bundle.

Returns:

The list of command documents to be sent.