com.mongodb

Class DBCollectionImpl

java.lang.Object

com.mongodb.DBCollection

com.mongodb.DBCollectionImpl

class DBCollectionImpl
extends DBCollection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DBCollectionImpl.OrderedRunGenerator
private class	DBCollectionImpl.Run
private class	DBCollectionImpl.UnorderedRunGenerator

Field Summary

Fields

Modifier and Type	Field and Description
private DBApiLayer	db
private java.lang.String	namespace
private static int	QUERY_DOCUMENT_HEADROOM
private static java.util.logging.Level	TRACE_LEVEL
private static java.util.logging.Logger	TRACE_LOGGER

Fields inherited from class com.mongodb.DBCollection

_db, _fullName, _hintFields, _name, _objectClass, _options

Constructor Summary

Constructors

Constructor and Description
DBCollectionImpl(DBApiLayer db, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
private void	addBulkWriteResultToCommandResult(BulkWriteResult bulkWriteResult, WriteRequest.Type type, CommandResult commandResult)
Cursor	aggregate(java.util.List<DBObject> pipeline, AggregationOptions options, ReadPreference readPreference) Method implements aggregation framework.
private void	applyRulesForInsert(java.util.List<DBObject> list)
void	createIndex(DBObject keys, DBObject options, DBEncoder encoder) Forces creation of an index on a set of fields, if one does not already exist.
void	doapply(DBObject o) Method to be overridden if you need to add any fields to a given document before saving it to the collection.
void	drop() Drops (deletes) this collection from the database.
(package private) BulkWriteResult	executeBulkWriteOperation(boolean ordered, java.lang.Boolean bypassDocumentValidation, java.util.List<WriteRequest> writeRequests, WriteConcern writeConcern, DBEncoder encoder)
(package private) QueryResultIterator	find(DBObject ref, DBObject fields, int numToSkip, int batchSize, int limit, int options, ReadPreference readPref, DBDecoder decoder) Finds objects
(package private) QueryResultIterator	find(DBObject ref, DBObject fields, int numToSkip, int batchSize, int limit, int options, ReadPreference readPref, DBDecoder decoder, DBEncoder encoder)
protected DBObject	findAndModifyImpl(DBObject query, DBObject fields, DBObject sort, boolean remove, DBObject update, boolean returnNew, boolean upsert, java.lang.Boolean bypassDocumentValidation, long maxTime, java.util.concurrent.TimeUnit maxTimeUnit, WriteConcern writeConcern) Atomically modify and return a single document.
java.util.List<DBObject>	getIndexInfo() Return a list of the indexes for this collection.
private java.util.logging.Logger	getLogger()
private int	getMaxWriteBatchSize(DBPort port)
private MessageSettings	getMessageSettings(DBPort port)
private MongoNamespace	getNamespace()
private java.lang.Iterable<DBCollectionImpl.Run>	getRunGenerator(boolean ordered, java.lang.Boolean bypassDocumentValidation, java.util.List<WriteRequest> writeRequests, WriteConcern writeConcern, DBEncoder encoder, DBPort port)
protected WriteResult	insertImpl(java.util.List<DBObject> list, WriteConcern concern, DBEncoder encoder, java.lang.Boolean bypassDocumentValidation) Insert documents into a collection.
private BulkWriteResult	insertWithCommandProtocol(java.util.List<DBObject> list, WriteConcern writeConcern, DBEncoder encoder, DBPort port, java.lang.Boolean bypassDocumentValidation)
private WriteResult	insertWithWriteProtocol(java.util.List<DBObject> list, WriteConcern concern, DBEncoder encoder, DBPort port, boolean shouldApply)
java.util.List<Cursor>	parallelScan(ParallelScanOptions options) Return a list of cursors over the collection that can be used to scan it in parallel.
private BasicDBObject	prepareFindAndModifyCommand(DBObject query, DBObject fields, DBObject sort, boolean remove, DBObject update, boolean returnNew, boolean upsert, java.lang.Boolean bypassDocumentValidation, long maxTime, java.util.concurrent.TimeUnit maxTimeUnit, WriteConcern writeConcern, ServerVersion serverVersion)
private CommandResult	receiveWriteCommandMessage(DBPort port)
WriteResult	remove(DBObject query, boolean multi, WriteConcern concern, DBEncoder encoder)
WriteResult	remove(DBObject query, WriteConcern concern, DBEncoder encoder) Remove documents from a collection.
private BulkWriteResult	removeWithCommandProtocol(java.util.List<RemoveRequest> removeList, WriteConcern writeConcern, DBEncoder encoder, DBPort port)
private BaseWriteCommandMessage	sendWriteCommandMessage(BaseWriteCommandMessage message, int batchNum, DBPort port)
private void	throwIfBypassDocumentValidationNotSupported(WriteConcern concern, java.lang.Boolean bypassDocumentValidation, DBPort port)
private void	trace(java.lang.String s)
private MongoException	translateBulkWriteException(BulkWriteException e, WriteRequest.Type type)
private WriteResult	translateBulkWriteResult(BulkWriteResult bulkWriteResult, WriteRequest.Type type, WriteConcern writeConcern, ServerAddress serverAddress)
protected WriteResult	updateImpl(DBObject query, DBObject o, boolean upsert, boolean multi, WriteConcern concern, java.lang.Boolean bypassDocumentValidation, DBEncoder encoder) Modify an existing document or documents in collection.
private BulkWriteResult	updateWithCommandProtocol(java.util.List<ModifyRequest> updates, WriteConcern writeConcern, java.lang.Boolean bypassDocumentValidation, DBEncoder encoder, DBPort port)
private boolean	useWriteCommands(WriteConcern concern, DBPort port)
private boolean	willTrace()
private BulkWriteResult	writeWithCommandProtocol(DBPort port, WriteRequest.Type type, BaseWriteCommandMessage message, WriteConcern writeConcern)

Methods inherited from class com.mongodb.DBCollection

_checkObject, addOption, aggregate, aggregate, aggregate, aggregate, apply, apply, checkReadOnly, command, count, count, count, createIndex, createIndex, createIndex, createIndex, createIndex, defaultOptions, distinct, distinct, distinct, distinct, dropIndex, dropIndex, dropIndexes, dropIndexes, ensureIndex, ensureIndex, ensureIndex, ensureIndex, ensureIndex, equals, executeBulkWriteOperation, executeBulkWriteOperation, explainAggregate, find, find, find, find, find, findAndModify, findAndModify, findAndModify, findAndModify, findAndModify, findAndModify, findAndModify, findAndModify, findAndRemove, findOne, findOne, findOne, findOne, findOne, findOne, findOne, findOne, findOne, genIndexName, getBypassDocumentValidationForServerVersion, getCollection, getCount, getCount, getCount, getCount, getCount, getCount, getCount, getCount, getCount, getDB, getDBDecoderFactory, getDBEncoderFactory, getDecoder, getFullName, getHintFields, getInternalClass, getName, getObjectClass, getOptions, getReadPreference, getStats, getWriteConcern, group, group, group, group, group, group, hashCode, initializeOrderedBulkOperation, initializeUnorderedBulkOperation, insert, insert, insert, insert, insert, insert, insert, insert, insert, isCapped, mapReduce, mapReduce, mapReduce, mapReduce, mapReduce, prepareAggregationCommand, remove, remove, rename, rename, replaceWithObjectClass, resetIndexCache, resetOptions, save, save, setDBDecoderFactory, setDBEncoderFactory, setHintFields, setInternalClass, setObjectClass, setOptions, setReadPreference, setWriteConcern, slaveOk, toString, update, update, update, update, update, updateMulti

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

QUERY_DOCUMENT_HEADROOM

private static final int QUERY_DOCUMENT_HEADROOM

See Also:

Constant Field Values

db

private final DBApiLayer db

namespace

private final java.lang.String namespace

TRACE_LOGGER

private static final java.util.logging.Logger TRACE_LOGGER

TRACE_LEVEL

private static final java.util.logging.Level TRACE_LEVEL

Constructor Detail

DBCollectionImpl

DBCollectionImpl(DBApiLayer db,
                 java.lang.String name)

Method Detail

find

QueryResultIterator find(DBObject ref,
                         DBObject fields,
                         int numToSkip,
                         int batchSize,
                         int limit,
                         int options,
                         ReadPreference readPref,
                         DBDecoder decoder)

Description copied from class: DBCollection

Finds objects

Specified by:

find in class DBCollection

find

QueryResultIterator find(DBObject ref,
                         DBObject fields,
                         int numToSkip,
                         int batchSize,
                         int limit,
                         int options,
                         ReadPreference readPref,
                         DBDecoder decoder,
                         DBEncoder encoder)

Specified by:

find in class DBCollection

aggregate

public Cursor aggregate(java.util.List<DBObject> pipeline,
                        AggregationOptions options,
                        ReadPreference readPreference)

Description copied from class: DBCollection

Method implements aggregation framework.

Specified by:

aggregate in class DBCollection

Parameters:

pipeline - operations to be performed in the aggregation pipeline

options - options to apply to the aggregation

readPreference - ReadPreference to be used for this operation

Returns:

the aggregation operation's result set

parallelScan

public java.util.List<Cursor> parallelScan(ParallelScanOptions options)

Description copied from class: DBCollection

Return a list of cursors over the collection that can be used to scan it in parallel.

Note: As of MongoDB 2.6, this method will work against a mongod, but not a mongos.

Specified by:

parallelScan in class DBCollection

Parameters:

options - the parallel scan options

Returns:

a list of cursors, whose size may be less than the number requested

executeBulkWriteOperation

BulkWriteResult executeBulkWriteOperation(boolean ordered,
                                          java.lang.Boolean bypassDocumentValidation,
                                          java.util.List<WriteRequest> writeRequests,
                                          WriteConcern writeConcern,
                                          DBEncoder encoder)

Specified by:

executeBulkWriteOperation in class DBCollection

insertImpl

protected WriteResult insertImpl(java.util.List<DBObject> list,
                                 WriteConcern concern,
                                 DBEncoder encoder,
                                 java.lang.Boolean bypassDocumentValidation)

Description copied from class: DBCollection

Insert documents into a collection. If the collection does not exists on the server, then it will be created. If the new document does not contain an '_id' field, it will be added.

Specified by:

insertImpl in class DBCollection

Parameters:

list - a list of DBObject's to be inserted

concern - WriteConcern to be used during operation

encoder - DBEncoder to use to serialise the documents

bypassDocumentValidation - whether to bypass document validation, or null if the server's default value should be used

Returns:

the result of the operation

remove

public WriteResult remove(DBObject query,
                          WriteConcern concern,
                          DBEncoder encoder)

Description copied from class: DBCollection

Remove documents from a collection.

Specified by:

remove in class DBCollection

Parameters:

query - the deletion criteria using query operators. Omit the query parameter or pass an empty document to delete all documents in the collection.

concern - WriteConcern to be used during operation

encoder - DBEncoder to be used

Returns:

the result of the operation

remove

public WriteResult remove(DBObject query,
                          boolean multi,
                          WriteConcern concern,
                          DBEncoder encoder)

updateImpl

protected WriteResult updateImpl(DBObject query,
                                 DBObject o,
                                 boolean upsert,
                                 boolean multi,
                                 WriteConcern concern,
                                 java.lang.Boolean bypassDocumentValidation,
                                 DBEncoder encoder)

Description copied from class: DBCollection

Modify an existing document or documents in collection. By default the method updates a single document. The query parameter employs the same query selectors, as used in DBCollection.find(DBObject).

Specified by:

updateImpl in class DBCollection

Parameters:

query - the selection criteria for the update

o - the modifications to apply

upsert - when true, inserts a document if no document matches the update query criteria

multi - when true, updates all documents in the collection that match the update query criteria, otherwise only updates one

concern - WriteConcern to be used during operation

bypassDocumentValidation - whether to bypass document validation, or null if the server's default should be used

encoder - the DBEncoder to use

Returns:

the result of the operation

findAndModifyImpl

protected DBObject findAndModifyImpl(DBObject query,
                                     DBObject fields,
                                     DBObject sort,
                                     boolean remove,
                                     DBObject update,
                                     boolean returnNew,
                                     boolean upsert,
                                     java.lang.Boolean bypassDocumentValidation,
                                     long maxTime,
                                     java.util.concurrent.TimeUnit maxTimeUnit,
                                     WriteConcern writeConcern)

Description copied from class: DBCollection

Atomically modify and return a single document. By default, the returned document does not include the modifications made on the update.

Specified by:

findAndModifyImpl in class DBCollection

Parameters:

query - specifies the selection criteria for the modification

fields - a subset of fields to return

sort - determines which document the operation will modify if the query selects multiple documents

remove - when true, removes the selected document

update - performs an update of the selected document

returnNew - when true, returns the modified document rather than the original

upsert - when true, operation creates a new document if the query returns no documents

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

maxTime - the maximum time that the server will allow this operation to execute before killing it. A non-zero value requires a server version >= 2.6

maxTimeUnit - the unit that maxTime is specified in

writeConcern - the write concern to apply to the operation

Returns:

the document as it was before the modifications, unless returnNew is true, in which case it returns the document after the changes were made

prepareFindAndModifyCommand

private BasicDBObject prepareFindAndModifyCommand(DBObject query,
                                                  DBObject fields,
                                                  DBObject sort,
                                                  boolean remove,
                                                  DBObject update,
                                                  boolean returnNew,
                                                  boolean upsert,
                                                  java.lang.Boolean bypassDocumentValidation,
                                                  long maxTime,
                                                  java.util.concurrent.TimeUnit maxTimeUnit,
                                                  WriteConcern writeConcern,
                                                  ServerVersion serverVersion)

drop

public void drop()

Description copied from class: DBCollection

Drops (deletes) this collection from the database. Use with care.

Overrides:

drop in class DBCollection

doapply

public void doapply(DBObject o)

Description copied from class: DBCollection

Method to be overridden if you need to add any fields to a given document before saving it to the collection.

Specified by:

doapply in class DBCollection

Parameters:

o - object to which to add the fields

translateBulkWriteResult

private WriteResult translateBulkWriteResult(BulkWriteResult bulkWriteResult,
                                             WriteRequest.Type type,
                                             WriteConcern writeConcern,
                                             ServerAddress serverAddress)

translateBulkWriteException

private MongoException translateBulkWriteException(BulkWriteException e,
                                                   WriteRequest.Type type)

addBulkWriteResultToCommandResult

private void addBulkWriteResultToCommandResult(BulkWriteResult bulkWriteResult,
                                               WriteRequest.Type type,
                                               CommandResult commandResult)

getIndexInfo

public java.util.List<DBObject> getIndexInfo()

Description copied from class: DBCollection

Return a list of the indexes for this collection. Each object in the list is the "info document" from MongoDB

Specified by:

getIndexInfo in class DBCollection

Returns:

list of index documents

createIndex

public void createIndex(DBObject keys,
                        DBObject options,
                        DBEncoder encoder)

Description copied from class: DBCollection

Forces creation of an index on a set of fields, if one does not already exist.

Specified by:

createIndex in class DBCollection

Parameters:

keys - a document that contains pairs with the name of the field or fields to index and order of the index

options - a document that controls the creation of the index.

encoder - specifies the encoder that used during operation

insertWithCommandProtocol

private BulkWriteResult insertWithCommandProtocol(java.util.List<DBObject> list,
                                                  WriteConcern writeConcern,
                                                  DBEncoder encoder,
                                                  DBPort port,
                                                  java.lang.Boolean bypassDocumentValidation)

applyRulesForInsert

private void applyRulesForInsert(java.util.List<DBObject> list)

removeWithCommandProtocol

private BulkWriteResult removeWithCommandProtocol(java.util.List<RemoveRequest> removeList,
                                                  WriteConcern writeConcern,
                                                  DBEncoder encoder,
                                                  DBPort port)

updateWithCommandProtocol

private BulkWriteResult updateWithCommandProtocol(java.util.List<ModifyRequest> updates,
                                                  WriteConcern writeConcern,
                                                  java.lang.Boolean bypassDocumentValidation,
                                                  DBEncoder encoder,
                                                  DBPort port)

writeWithCommandProtocol

private BulkWriteResult writeWithCommandProtocol(DBPort port,
                                                 WriteRequest.Type type,
                                                 BaseWriteCommandMessage message,
                                                 WriteConcern writeConcern)

useWriteCommands

private boolean useWriteCommands(WriteConcern concern,
                                 DBPort port)

throwIfBypassDocumentValidationNotSupported

private void throwIfBypassDocumentValidationNotSupported(WriteConcern concern,
                                                         java.lang.Boolean bypassDocumentValidation,
                                                         DBPort port)

getMessageSettings

private MessageSettings getMessageSettings(DBPort port)

getMaxWriteBatchSize

private int getMaxWriteBatchSize(DBPort port)

getNamespace

private MongoNamespace getNamespace()

sendWriteCommandMessage

private BaseWriteCommandMessage sendWriteCommandMessage(BaseWriteCommandMessage message,
                                                        int batchNum,
                                                        DBPort port)
                                                 throws java.io.IOException

Throws:

java.io.IOException

receiveWriteCommandMessage

private CommandResult receiveWriteCommandMessage(DBPort port)
                                          throws java.io.IOException

Throws:

java.io.IOException

insertWithWriteProtocol

private WriteResult insertWithWriteProtocol(java.util.List<DBObject> list,
                                            WriteConcern concern,
                                            DBEncoder encoder,
                                            DBPort port,
                                            boolean shouldApply)

getRunGenerator

private java.lang.Iterable<DBCollectionImpl.Run> getRunGenerator(boolean ordered,
                                                                 java.lang.Boolean bypassDocumentValidation,
                                                                 java.util.List<WriteRequest> writeRequests,
                                                                 WriteConcern writeConcern,
                                                                 DBEncoder encoder,
                                                                 DBPort port)

willTrace

private boolean willTrace()

trace

private void trace(java.lang.String s)

getLogger

private java.util.logging.Logger getLogger()