com.allanbank.mongodb.client

Class BatchedAsyncMongoCollectionImpl

java.lang.Object

com.allanbank.mongodb.client.AbstractMongoOperations

com.allanbank.mongodb.client.AbstractAsyncMongoCollection

com.allanbank.mongodb.client.BatchedAsyncMongoCollectionImpl

All Implemented Interfaces:

AsyncMongoCollection, BatchedAsyncMongoCollection, Closeable, AutoCloseable

public class BatchedAsyncMongoCollectionImpl
extends AbstractAsyncMongoCollection
implements BatchedAsyncMongoCollection

BatchedAsyncMongoCollectionImpl provides the implementation for the BatchedAsyncMongoCollection.

Copyright ©:

2013-2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields inherited from class com.allanbank.mongodb.client.AbstractMongoOperations

DELETE_SINGLE_DELETE_DEFAULT, EMPTY_INDEX_OPTIONS, ID_FIELD_NAME, INSERT_CONTINUE_ON_ERROR_DEFAULT, myClient, myDatabase, myName, UNIQUE_INDEX_OPTIONS, UPDATE_MULTIUPDATE_DEFAULT, UPDATE_UPSERT_DEFAULT

Fields inherited from interface com.allanbank.mongodb.AsyncMongoCollection

ALL, NONE

Constructor Summary

Constructors

Constructor and Description
BatchedAsyncMongoCollectionImpl(Client client, MongoDatabase database, String name) Creates a new BatchedAsyncMongoCollectionImpl.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the pending batch of operations without sending them to the server.
void	close() Flushes the pending batch and submits all of the pending requests to the server.
void	flush() Flushes the pending batch and submits all of the pending requests to the server.
BatchedWriteMode	getMode() Returns the mode for the batched writes.
boolean	isBatchDeletes() Returns true if the deletes should be batched.
boolean	isBatchUpdates() Returns true if the updates should be batched.
void	setBatchDeletes(boolean batchDeletes) Sets if deletes should be batched.
void	setBatchUpdates(boolean batchUpdates) Sets if updates should be batched.
void	setMode(BatchedWriteMode mode) Sets the default mode for batching of writes.
protected boolean	useWriteCommand() Extension point for derived classes to force the AbstractMongoOperations.insertAsync(Callback, boolean, Durability, DocumentAssignable...) , AbstractMongoOperations.updateAsync(Callback, DocumentAssignable, DocumentAssignable, boolean, boolean, Durability) , and AbstractMongoOperations.deleteAsync(Callback, DocumentAssignable, boolean, Durability) methods to use the legacy Insert, Update, and Delete messages regardless of the server version.

Methods inherited from class com.allanbank.mongodb.client.AbstractAsyncMongoCollection

aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, getLockType, groupByAsync, groupByAsync, groupByAsync, groupByAsync, groupByAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, saveAsync, saveAsync, saveAsync, saveAsync, saveAsync, stream, stream, stream, stream, stream, stream, streamingFind, streamingFind, streamingFind, streamingFind, streamingFind, streamingFind, textSearchAsync, textSearchAsync, textSearchAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, writeAsync, writeAsync, writeAsync, writeAsync, writeAsync

Methods inherited from class com.allanbank.mongodb.client.AbstractMongoOperations

aggregateAsync, asGetLastError, countAsync, createQuery, deleteAsync, distinctAsync, doInsertAsync, doWriteAsync, explainAsync, explainAsync, findAndModifyAsync, findAsync, findOneAsync, getDatabaseName, getDurability, getName, getReadPreference, groupByAsync, insertAsync, isWriteCommandsSupported, mapReduceAsync, parallelScanAsync, saveAsync, setDurability, setReadPreference, stream, stream, textSearchAsync, toCommand, updateAsync, updateReadPreference, writeAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.allanbank.mongodb.AsyncMongoCollection

aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, aggregateAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, countAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, distinctAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, explainAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAndModifyAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, findOneAsync, groupByAsync, groupByAsync, groupByAsync, groupByAsync, groupByAsync, groupByAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, insertAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, mapReduceAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, parallelScanAsync, saveAsync, saveAsync, saveAsync, saveAsync, saveAsync, saveAsync, stream, stream, stream, stream, stream, stream, stream, stream, streamingFind, streamingFind, streamingFind, streamingFind, streamingFind, streamingFind, textSearchAsync, textSearchAsync, textSearchAsync, textSearchAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, updateAsync, writeAsync, writeAsync, writeAsync, writeAsync, writeAsync, writeAsync

Constructor Detail

BatchedAsyncMongoCollectionImpl

public BatchedAsyncMongoCollectionImpl(Client client,
                               MongoDatabase database,
                               String name)

Creates a new BatchedAsyncMongoCollectionImpl.

Parameters:

client - The client for interacting with MongoDB.

database - The database we interact with.

name - The name of the collection we interact with.

Method Detail

cancel

public void cancel()

Cancels the pending batch of operations without sending them to the server.

After canceling the current batch you may continue to accumulate additional operations to be sent in a different batch.

Overridden to clear any pending messages without sending them to MongoDB.

Specified by:

cancel in interface BatchedAsyncMongoCollection

close

public void close()
           throws MongoDbException

Flushes the pending batch and submits all of the pending requests to the server.

This method is equivalent to BatchedAsyncMongoCollection.flush() and is only provided to implement the Closeable interface to support try-with-resource.

Overridden to flush any pending messages to a real serialized client.

Specified by:

close in interface BatchedAsyncMongoCollection

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

MongoDbException - If there is an error submitting the batched requests.

flush

public void flush()
           throws MongoDbException

Flushes the pending batch and submits all of the pending requests to the server.

After flushing the current batch you may continue to accumulate additional operations to be sent in a different batch.

Overridden to flush any pending messages to a real serialized client.

Specified by:

flush in interface BatchedAsyncMongoCollection

Throws:

MongoDbException - If there is an error submitting the batched requests.

getMode

public BatchedWriteMode getMode()

Returns the mode for the batched writes.

Returns:

The mode for the batched writes.

isBatchDeletes

public boolean isBatchDeletes()

Returns true if the deletes should be batched.

Returns:

True if the deletes should be batched.

isBatchUpdates

public boolean isBatchUpdates()

Returns true if the updates should be batched.

Returns:

True if the updates should be batched.

setBatchDeletes

public void setBatchDeletes(boolean batchDeletes)

Sets if deletes should be batched. Set to true to batch deletes.

Defaults to false since there is no way to determine how many documents each deletes removed when they are batched.

This setting takes effect for a batch when it is closed or flushed. Intermediate changes between flushes have no effect.

Specified by:

setBatchDeletes in interface BatchedAsyncMongoCollection

Parameters:

batchDeletes - Set to true to batch deletes.

See Also:

SERVER-12858

setBatchUpdates

public void setBatchUpdates(boolean batchUpdates)

Sets if updates should be batched. Set to true to batch updates.

Defaults to false since there is no way to determine how many documents each update touched when they are batched.

This setting takes effect for a batch when it is closed or flushed. Intermediate changes between flushes have no effect.

Specified by:

setBatchUpdates in interface BatchedAsyncMongoCollection

Parameters:

batchUpdates - Set to true to batch updates.

See Also:

SERVER-12858

setMode

public void setMode(BatchedWriteMode mode)

Sets the default mode for batching of writes. This is only applicable to situations where the server supports the MongoDB write command (i.e., version 2.6 and later). There are two cases where the mode will be ignored:

• All inserts with continueOnError set to true will be executed as distinct batches.
• Any change in the durability within the sequence of writes will case the writes to be broken across batches sent to the server. This does not apply to Durability.ACK and Durability.NONE writes and they may be grouped with other writes. Users should be aware that this may cause unexpected write concern failures in those cases.

The default mode is BatchedWriteMode.SERIALIZE_AND_CONTINUE. This provides reasonable performance while maintaining the expected semantics. Note that this mode has the effect of coalescing sequences of inserts (where continueOnError is true), updates and deletes into single operations.

The BatchedWriteMode.SERIALIZE_AND_STOP will cause each insert, update, and delete to be sent as independent commands.

The BatchedWriteMode.REORDERED will cause each sequence of inserts, updates, and deletes without any other command or query to be groups together, reordered, and executed together. This includes the reordering writes within a type (one insert before another to better packet the messages) as well as reordering the writes across types (a delete before an insert to build larger batches).

The mode setting takes effect for a batch when it is closed or flushed. Intermediate changes between flushes have no effect.

Warning: In the case of BatchedWriteMode.SERIALIZE_AND_CONTINUE and BatchedWriteMode.REORDERED it is impossible to determine the number of documents each update and/or delete touched. In these cases each update in the batch will be returned the number of documents touched by the batch as a whole. For this reason the batching of updates and deletes is disabled. It can be enabled by setting BatchedAsyncMongoCollection.setBatchUpdates(boolean) and BatchedAsyncMongoCollection.setBatchDeletes(boolean) to true. We have written a bug report (SERVER-12858) to have the additional information added to the responses so we can remove this restriction.

Specified by:

setMode in interface BatchedAsyncMongoCollection

Parameters:

mode - The default mode for

See Also:

SERVER-12858

useWriteCommand

protected boolean useWriteCommand()

Extension point for derived classes to force the AbstractMongoOperations.insertAsync(Callback, boolean, Durability, DocumentAssignable...) , AbstractMongoOperations.updateAsync(Callback, DocumentAssignable, DocumentAssignable, boolean, boolean, Durability) , and AbstractMongoOperations.deleteAsync(Callback, DocumentAssignable, boolean, Durability) methods to use the legacy Insert, Update, and Delete messages regardless of the server version.

This version of the method always returns true.

Overridden to return false to force the AbstractMongoOperations class to always use the legacy Insert, Update, and Delete messages. The CaptureClientHandler.optimize() will convert those operations to bulk write commands as appropriate.

Overrides:

useWriteCommand in class AbstractMongoOperations

Returns:

Return true to allow the use of the write commands added in MongoDB 2.6. Use false to force the use of the Insert, Update, and Delete