MongoTemplate (Spring Data MongoDB - Core 1.6.3.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.MongoTemplate

All Implemented Interfaces:

Aware, ApplicationContextAware, MongoOperations
```
public class MongoTemplate
extends Object
implements MongoOperations, ApplicationContextAware
```
Primary implementation of MongoOperations.

Author:

Thomas Risberg, Graeme Rocher, Mark Pollack, Oliver Gierke, Amol Nayak, Patryk Wasik, Tobias Trelle, Sebastian Herold, Thomas Darimont, Chuong Ngo, Christoph Strobl

Constructor Summary

Constructors
Constructor and Description
`MongoTemplate(MongoDbFactory mongoDbFactory)` Constructor used for a basic template configuration.
`MongoTemplate(MongoDbFactory mongoDbFactory, MongoConverter mongoConverter)` Constructor used for a basic template configuration.
`MongoTemplate(com.mongodb.Mongo mongo, String databaseName)` Constructor used for a basic template configuration
`MongoTemplate(com.mongodb.Mongo mongo, String databaseName, UserCredentials userCredentials)` Constructor used for a template configuration with user credentials in the form of `UserCredentials`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<O> AggregationResults<O>`	`aggregate(Aggregation aggregation, Class<?> inputType, Class<O> outputType)` Execute an aggregation operation.
`<O> AggregationResults<O>`	`aggregate(Aggregation aggregation, String collectionName, Class<O> outputType)` Execute an aggregation operation.
`protected <O> AggregationResults<O>`	`aggregate(Aggregation aggregation, String collectionName, Class<O> outputType, AggregationOperationContext context)`
`<O> AggregationResults<O>`	`aggregate(TypedAggregation<?> aggregation, Class<O> outputType)` Execute an aggregation operation.
`<O> AggregationResults<O>`	`aggregate(TypedAggregation<?> aggregation, String inputCollectionName, Class<O> outputType)` Execute an aggregation operation.
`<T> boolean`	`collectionExists(Class<T> entityClass)` Check to see if a collection with a name indicated by the entity class exists.
`boolean`	`collectionExists(String collectionName)` Check to see if a collection with a given name exists.
`protected com.mongodb.DBObject`	`convertToDbObject(CollectionOptions collectionOptions)`
`long`	`count(Query query, Class<?> entityClass)` Returns the number of documents for the given `Query` by querying the collection of the given entity class.
`long`	`count(Query query, Class<?> entityClass, String collectionName)` Returns the number of documents for the given `Query` by querying the given collection using the given entity class to map the given `Query`.
`long`	`count(Query query, String collectionName)` Returns the number of documents for the given `Query` querying the given collection.
`<T> com.mongodb.DBCollection`	`createCollection(Class<T> entityClass)` Create an uncapped collection with a name based on the provided entity class.
`<T> com.mongodb.DBCollection`	`createCollection(Class<T> entityClass, CollectionOptions collectionOptions)` Create a collect with a name based on the provided entity class using the options.
`com.mongodb.DBCollection`	`createCollection(String collectionName)` Create an uncapped collection with the provided name.
`com.mongodb.DBCollection`	`createCollection(String collectionName, CollectionOptions collectionOptions)` Create a collect with the provided name and options.
`protected com.mongodb.DBCollection`	`doCreateCollection(String collectionName, com.mongodb.DBObject collectionOptions)` Create the specified collection using the provided options
`protected <S,T> List<T>`	`doFind(String collectionName, com.mongodb.DBObject query, com.mongodb.DBObject fields, Class<S> entityClass, org.springframework.data.mongodb.core.CursorPreparer preparer, org.springframework.data.mongodb.core.MongoTemplate.DbObjectCallback<T> objectCallback)`
`protected <T> List<T>`	`doFind(String collectionName, com.mongodb.DBObject query, com.mongodb.DBObject fields, Class<T> entityClass)` Map the results of an ad-hoc query on the default MongoDB collection to a List using the template's converter.
`protected <T> List<T>`	`doFind(String collectionName, com.mongodb.DBObject query, com.mongodb.DBObject fields, Class<T> entityClass, org.springframework.data.mongodb.core.CursorPreparer preparer)` Map the results of an ad-hoc query on the default MongoDB collection to a List of the specified type.
`protected <T> List<T>`	`doFindAndDelete(String collectionName, Query query, Class<T> entityClass)` Retrieve and remove all documents matching the given `query` by calling `find(Query, Class, String)` and `remove(Query, Class, String)`, whereas the `Query` for `remove(Query, Class, String)` is constructed out of the find result.
`protected <T> T`	`doFindAndModify(String collectionName, com.mongodb.DBObject query, com.mongodb.DBObject fields, com.mongodb.DBObject sort, Class<T> entityClass, Update update, FindAndModifyOptions options)`
`protected <T> T`	`doFindAndRemove(String collectionName, com.mongodb.DBObject query, com.mongodb.DBObject fields, com.mongodb.DBObject sort, Class<T> entityClass)` Map the results of an ad-hoc query on the default MongoDB collection to an object using the template's converter.
`protected <T> T`	`doFindOne(String collectionName, com.mongodb.DBObject query, com.mongodb.DBObject fields, Class<T> entityClass)` Map the results of an ad-hoc query on the default MongoDB collection to an object using the template's converter.
`protected <T> void`	`doInsert(String collectionName, T objectToSave, MongoWriter<T> writer)`
`protected <T> void`	`doInsertAll(Collection<? extends T> listToSave, MongoWriter<T> writer)`
`protected <T> void`	`doInsertBatch(String collectionName, Collection<? extends T> batchToSave, MongoWriter<T> writer)`
`protected <T> com.mongodb.WriteResult`	`doRemove(String collectionName, Query query, Class<T> entityClass)`
`protected <T> void`	`doSave(String collectionName, T objectToSave, MongoWriter<T> writer)`
`protected com.mongodb.WriteResult`	`doUpdate(String collectionName, Query query, Update update, Class<?> entityClass, boolean upsert, boolean multi)`
`<T> void`	`dropCollection(Class<T> entityClass)` Drop the collection with the name indicated by the entity class.
`void`	`dropCollection(String collectionName)` Drop the collection with the given name.
`protected void`	`ensureNotIterable(Object o)`
`<T> T`	`execute(Class<?> entityClass, CollectionCallback<T> callback)` Executes the given `CollectionCallback` on the entity collection of the specified class.
`<T> T`	`execute(DbCallback<T> action)` Executes a `DbCallback` translating any exceptions as necessary.
`<T> T`	`execute(String collectionName, CollectionCallback<T> callback)` Executes the given `CollectionCallback` on the collection of the given name.
`com.mongodb.CommandResult`	`executeCommand(com.mongodb.DBObject command)` Execute a MongoDB command.
`com.mongodb.CommandResult`	`executeCommand(com.mongodb.DBObject command, int options)` Execute a MongoDB command.
`com.mongodb.CommandResult`	`executeCommand(String jsonCommand)` Execute the a MongoDB command expressed as a JSON string.
`<T> T`	`executeInSession(DbCallback<T> action)` Executes the given `DbCallback` within the same connection to the database so as to ensure consistency in a write heavy environment where you may read the data that you wrote.
`void`	`executeQuery(Query query, String collectionName, DocumentCallbackHandler dch)` Execute a MongoDB query and iterate over the query results on a per-document basis with a DocumentCallbackHandler.
`protected void`	`executeQuery(Query query, String collectionName, DocumentCallbackHandler dch, org.springframework.data.mongodb.core.CursorPreparer preparer)` Execute a MongoDB query and iterate over the query results on a per-document basis with a `DocumentCallbackHandler` using the provided CursorPreparer.
`boolean`	`exists(Query query, Class<?> entityClass)` Determine result of given `Query` contains at least one element.
`boolean`	`exists(Query query, Class<?> entityClass, String collectionName)` Determine result of given `Query` contains at least one element.
`boolean`	`exists(Query query, String collectionName)` Determine result of given `Query` contains at least one element.
`<T> List<T>`	`find(Query query, Class<T> entityClass)` Map the results of an ad-hoc query on the collection for the entity class to a List of the specified type.
`<T> List<T>`	`find(Query query, Class<T> entityClass, String collectionName)` Map the results of an ad-hoc query on the specified collection to a List of the specified type.
`<T> List<T>`	`findAll(Class<T> entityClass)` Query for a list of objects of type T from the collection used by the entity class.
`<T> List<T>`	`findAll(Class<T> entityClass, String collectionName)` Query for a list of objects of type T from the specified collection.
`<T> List<T>`	`findAllAndRemove(Query query, Class<T> entityClass)` Returns and removes all documents matching the given query form the collection used to store the entityClass.
`<T> List<T>`	`findAllAndRemove(Query query, Class<T> entityClass, String collectionName)` Returns and removes all documents that match the provided query document criteria from the the collection used to store the entityClass.
`<T> List<T>`	`findAllAndRemove(Query query, String collectionName)` Returns and removes all documents form the specified collection that match the provided query.
`<T> T`	`findAndModify(Query query, Update update, Class<T> entityClass)` Triggers findAndModify to apply provided `Update` on documents matching `Criteria` of given `Query`.
`<T> T`	`findAndModify(Query query, Update update, Class<T> entityClass, String collectionName)` Triggers findAndModify to apply provided `Update` on documents matching `Criteria` of given `Query`.
`<T> T`	`findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass)` Triggers findAndModify to apply provided `Update` on documents matching `Criteria` of given `Query` taking `FindAndModifyOptions` into account.
`<T> T`	`findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass, String collectionName)` Triggers findAndModify to apply provided `Update` on documents matching `Criteria` of given `Query` taking `FindAndModifyOptions` into account.
`<T> T`	`findAndRemove(Query query, Class<T> entityClass)` Map the results of an ad-hoc query on the collection for the entity type to a single instance of an object of the specified type.
`<T> T`	`findAndRemove(Query query, Class<T> entityClass, String collectionName)` Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type.
`<T> T`	`findById(Object id, Class<T> entityClass)` Returns a document with the given id mapped onto the given class.
`<T> T`	`findById(Object id, Class<T> entityClass, String collectionName)` Returns the document with the given id from the given collection mapped onto the given target class.
`<T> T`	`findOne(Query query, Class<T> entityClass)` Map the results of an ad-hoc query on the collection for the entity class to a single instance of an object of the specified type.
`<T> T`	`findOne(Query query, Class<T> entityClass, String collectionName)` Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type.
`<T> GeoResults<T>`	`geoNear(NearQuery near, Class<T> entityClass)` Returns `GeoResults` for all entities matching the given `NearQuery`.
`<T> GeoResults<T>`	`geoNear(NearQuery near, Class<T> entityClass, String collectionName)` Returns `GeoResults` for all entities matching the given `NearQuery`.
`com.mongodb.DBCollection`	`getCollection(String collectionName)` Get a collection by name, creating it if it doesn't exist.
`String`	`getCollectionName(Class<?> entityClass)` The collection name used for the specified class by this template.
`Set<String>`	`getCollectionNames()` A set of collection names.
`MongoConverter`	`getConverter()` Returns the default `org.springframework.data.mongodb.core.core.convert.MongoConverter`.
`com.mongodb.DB`	`getDb()`
`<T> GroupByResults<T>`	`group(Criteria criteria, String inputCollectionName, GroupBy groupBy, Class<T> entityClass)` Execute a group operation restricting the rows to those which match the provided Criteria.
`<T> GroupByResults<T>`	`group(String inputCollectionName, GroupBy groupBy, Class<T> entityClass)` Execute a group operation over the entire collection.
`protected void`	`handleAnyWriteResultErrors(com.mongodb.WriteResult writeResult, com.mongodb.DBObject query, MongoActionOperation operation)` Handles `WriteResult` errors based on the configured `WriteResultChecking`.
`IndexOperations`	`indexOps(Class<?> entityClass)` Returns the operations that can be performed on indexes
`IndexOperations`	`indexOps(String collectionName)` Returns the operations that can be performed on indexes
`void`	`insert(Collection<? extends Object> batchToSave, Class<?> entityClass)` Insert a Collection of objects into a collection in a single batch write to the database.
`void`	`insert(Collection<? extends Object> batchToSave, String collectionName)` Insert a list of objects into the specified collection in a single batch write to the database.
`void`	`insert(Object objectToSave)` Insert the object into the collection for the entity type of the object to save.
`void`	`insert(Object objectToSave, String collectionName)` Insert the object into the specified collection.
`void`	`insertAll(Collection<? extends Object> objectsToSave)` Insert a mixed Collection of objects into a database collection determining the collection name to use based on the class.
`protected Object`	`insertDBObject(String collectionName, com.mongodb.DBObject dbDoc, Class<?> entityClass)`
`protected List<org.bson.types.ObjectId>`	`insertDBObjectList(String collectionName, List<com.mongodb.DBObject> dbDocList)`
`protected void`	`logCommandExecutionError(com.mongodb.DBObject command, com.mongodb.CommandResult result)`
`<T> MapReduceResults<T>`	`mapReduce(Query query, String inputCollectionName, String mapFunction, String reduceFunction, Class<T> entityClass)` Execute a map-reduce operation that takes a query.
`<T> MapReduceResults<T>`	`mapReduce(Query query, String inputCollectionName, String mapFunction, String reduceFunction, MapReduceOptions mapReduceOptions, Class<T> entityClass)` Execute a map-reduce operation that takes a query and additional map-reduce options
`<T> MapReduceResults<T>`	`mapReduce(String inputCollectionName, String mapFunction, String reduceFunction, Class<T> entityClass)` Execute a map-reduce operation.
`<T> MapReduceResults<T>`	`mapReduce(String inputCollectionName, String mapFunction, String reduceFunction, MapReduceOptions mapReduceOptions, Class<T> entityClass)` Execute a map-reduce operation that takes additional map-reduce options.
`protected <T> void`	`maybeEmitEvent(MongoMappingEvent<T> event)`
`protected void`	`populateIdIfNecessary(Object savedObject, Object id)` Populates the id property of the saved object, if it's not set already.
`protected void`	`prepareCollection(com.mongodb.DBCollection collection)` Prepare the collection before any processing is done using it.
`protected com.mongodb.WriteConcern`	`prepareWriteConcern(MongoAction mongoAction)` Prepare the WriteConcern before any processing is done using it.
`com.mongodb.WriteResult`	`remove(Object object)` Remove the given object from the collection by id.
`com.mongodb.WriteResult`	`remove(Object object, String collection)` Removes the given object from the given collection.
`com.mongodb.WriteResult`	`remove(Query query, Class<?> entityClass)` Remove all documents that match the provided query document criteria from the the collection used to store the entityClass.
`com.mongodb.WriteResult`	`remove(Query query, Class<?> entityClass, String collectionName)` Remove all documents that match the provided query document criteria from the the collection used to store the entityClass.
`com.mongodb.WriteResult`	`remove(Query query, String collectionName)` Remove all documents from the specified collection that match the provided query document criteria.
`protected String`	`replaceWithResourceIfNecessary(String function)`
`void`	`save(Object objectToSave)` Save the object to the collection for the entity type of the object to save.
`void`	`save(Object objectToSave, String collectionName)` Save the object to the specified collection.
`protected Object`	`saveDBObject(String collectionName, com.mongodb.DBObject dbDoc, Class<?> entityClass)`
`void`	`setApplicationContext(ApplicationContext applicationContext)`
`void`	`setReadPreference(com.mongodb.ReadPreference readPreference)` Used by @{link `prepareCollection(DBCollection)` to set the `ReadPreference` before any operations are performed.
`void`	`setWriteConcern(com.mongodb.WriteConcern writeConcern)` Configures the `WriteConcern` to be used with the template.
`void`	`setWriteConcernResolver(WriteConcernResolver writeConcernResolver)` Configures the `WriteConcernResolver` to be used with the template.
`void`	`setWriteResultChecking(WriteResultChecking resultChecking)` Configures the `WriteResultChecking` to be used with the template.
`com.mongodb.WriteResult`	`updateFirst(Query query, Update update, Class<?> entityClass)` Updates the first object that is found in the collection of the entity class that matches the query document with the provided update document.
`com.mongodb.WriteResult`	`updateFirst(Query query, Update update, Class<?> entityClass, String collectionName)` Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.
`com.mongodb.WriteResult`	`updateFirst(Query query, Update update, String collectionName)` Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.
`com.mongodb.WriteResult`	`updateMulti(Query query, Update update, Class<?> entityClass)` Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.
`com.mongodb.WriteResult`	`updateMulti(Query query, Update update, Class<?> entityClass, String collectionName)` Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.
`com.mongodb.WriteResult`	`updateMulti(Query query, Update update, String collectionName)` Updates all objects that are found in the specified collection that matches the query document criteria with the provided updated document.
`com.mongodb.WriteResult`	`upsert(Query query, Update update, Class<?> entityClass)` Performs an upsert.
`com.mongodb.WriteResult`	`upsert(Query query, Update update, Class<?> entityClass, String collectionName)` Performs an upsert.
`com.mongodb.WriteResult`	`upsert(Query query, Update update, String collectionName)` Performs an upsert.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MongoTemplate
```
public MongoTemplate(com.mongodb.Mongo mongo,
                     String databaseName)
```
    Constructor used for a basic template configuration
    
    Parameters:
    
    mongo - must not be null.
    
    databaseName - must not be null or empty.
  - MongoTemplate
```
public MongoTemplate(com.mongodb.Mongo mongo,
                     String databaseName,
                     UserCredentials userCredentials)
```
    Constructor used for a template configuration with user credentials in the form of UserCredentials
    
    Parameters:
    
    mongo - must not be null.
    
    databaseName - must not be null or empty.
    
    userCredentials -
  - MongoTemplate
```
public MongoTemplate(MongoDbFactory mongoDbFactory)
```
    Constructor used for a basic template configuration.
    
    Parameters:
    
    mongoDbFactory - must not be null.
  - MongoTemplate
```
public MongoTemplate(MongoDbFactory mongoDbFactory,
                     MongoConverter mongoConverter)
```
    Constructor used for a basic template configuration.
    
    Parameters:
    
    mongoDbFactory - must not be null.
    
    mongoConverter -
- Method Detail
  - setWriteResultChecking
```
public void setWriteResultChecking(WriteResultChecking resultChecking)
```
    Configures the WriteResultChecking to be used with the template. Setting null will reset the default of .
    
    Parameters:
    
    resultChecking -
  - setWriteConcern
```
public void setWriteConcern(com.mongodb.WriteConcern writeConcern)
```
    Configures the WriteConcern to be used with the template. If none is configured the WriteConcern configured on the MongoDbFactory will apply. If you configured a Mongo instance no WriteConcern will be used.
    
    Parameters:
    
    writeConcern -
  - setWriteConcernResolver
```
public void setWriteConcernResolver(WriteConcernResolver writeConcernResolver)
```
    Configures the WriteConcernResolver to be used with the template.
    
    Parameters:
    
    writeConcernResolver -
  - setReadPreference
```
public void setReadPreference(com.mongodb.ReadPreference readPreference)
```
    Used by @{link prepareCollection(DBCollection) to set the ReadPreference before any operations are performed.
    
    Parameters:
    
    readPreference -
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException
```
    Specified by:
    
    setApplicationContext in interface ApplicationContextAware
    
    Throws:
    
    BeansException
  - getConverter
```
public MongoConverter getConverter()
```
    Returns the default org.springframework.data.mongodb.core.core.convert.MongoConverter.
    
    Specified by:
    
    getConverter in interface MongoOperations
    
    Returns:
  - getCollectionName
```
public String getCollectionName(Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    The collection name used for the specified class by this template.
    
    Specified by:
    
    getCollectionName in interface MongoOperations
    
    Parameters:
    
    entityClass - must not be null.
    
    Returns:
  - executeCommand
```
public com.mongodb.CommandResult executeCommand(String jsonCommand)
```
    Description copied from interface: MongoOperations
    
    Execute the a MongoDB command expressed as a JSON string. This will call the method JSON.parse that is part of the MongoDB driver to convert the JSON string to a DBObject. Any errors that result from executing this command will be converted into Spring's DAO exception hierarchy.
    
    Specified by:
    
    executeCommand in interface MongoOperations
    
    Parameters:
    
    jsonCommand - a MongoDB command expressed as a JSON string.
  - executeCommand
```
public com.mongodb.CommandResult executeCommand(com.mongodb.DBObject command)
```
    Description copied from interface: MongoOperations
    
    Execute a MongoDB command. Any errors that result from executing this command will be converted into Spring's DAO exception hierarchy.
    
    Specified by:
    
    executeCommand in interface MongoOperations
    
    Parameters:
    
    command - a MongoDB command
  - executeCommand
```
public com.mongodb.CommandResult executeCommand(com.mongodb.DBObject command,
                                                int options)
```
    Description copied from interface: MongoOperations
    
    Execute a MongoDB command. Any errors that result from executing this command will be converted into Spring's DAO exception hierarchy.
    
    Specified by:
    
    executeCommand in interface MongoOperations
    
    Parameters:
    
    command - a MongoDB command
    
    options - query options to use
  - logCommandExecutionError
```
protected void logCommandExecutionError(com.mongodb.DBObject command,
                                        com.mongodb.CommandResult result)
```
  - executeQuery
```
public void executeQuery(Query query,
                         String collectionName,
                         DocumentCallbackHandler dch)
```
    Description copied from interface: MongoOperations
    
    Execute a MongoDB query and iterate over the query results on a per-document basis with a DocumentCallbackHandler.
    
    Specified by:
    
    executeQuery in interface MongoOperations
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification
    
    collectionName - name of the collection to retrieve the objects from
    
    dch - the handler that will extract results, one document at a time
  - executeQuery
```
protected void executeQuery(Query query,
                            String collectionName,
                            DocumentCallbackHandler dch,
                            org.springframework.data.mongodb.core.CursorPreparer preparer)
```
    Execute a MongoDB query and iterate over the query results on a per-document basis with a DocumentCallbackHandler using the provided CursorPreparer.
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification, must not be null.
    
    collectionName - name of the collection to retrieve the objects from
    
    dch - the handler that will extract results, one document at a time
    
    preparer - allows for customization of the DBCursor used when iterating over the result set, (apply limits, skips and so on).
  - execute
```
public <T> T execute(DbCallback<T> action)
```
    Description copied from interface: MongoOperations
    
    Executes a DbCallback translating any exceptions as necessary.
    Allows for returning a result object, that is a domain object or a collection of domain objects.
    
    Specified by:
    
    execute in interface MongoOperations
    
    Type Parameters:
    
    T - return type
    
    Parameters:
    
    action - callback object that specifies the MongoDB actions to perform on the passed in DB instance.
    
    Returns:
    
    a result object returned by the action or null
  - execute
```
public <T> T execute(Class<?> entityClass,
                     CollectionCallback<T> callback)
```
    Description copied from interface: MongoOperations
    
    Executes the given CollectionCallback on the entity collection of the specified class.
    Allows for returning a result object, that is a domain object or a collection of domain objects.
    
    Specified by:
    
    execute in interface MongoOperations
    
    Type Parameters:
    
    T - return type
    
    Parameters:
    
    entityClass - class that determines the collection to use
    
    callback - callback object that specifies the MongoDB action
    
    Returns:
    
    a result object returned by the action or null
  - execute
```
public <T> T execute(String collectionName,
                     CollectionCallback<T> callback)
```
    Description copied from interface: MongoOperations
    
    Executes the given CollectionCallback on the collection of the given name.
    Allows for returning a result object, that is a domain object or a collection of domain objects.
    
    Specified by:
    
    execute in interface MongoOperations
    
    Type Parameters:
    
    T - return type
    
    Parameters:
    
    collectionName - the name of the collection that specifies which DBCollection instance will be passed into
    
    callback - callback object that specifies the MongoDB action the callback action.
    
    Returns:
    
    a result object returned by the action or null
  - executeInSession
```
public <T> T executeInSession(DbCallback<T> action)
```
    Description copied from interface: MongoOperations
    
    Executes the given DbCallback within the same connection to the database so as to ensure consistency in a write heavy environment where you may read the data that you wrote. See the comments on Java Driver Concurrency
    Allows for returning a result object, that is a domain object or a collection of domain objects.
    
    Specified by:
    
    executeInSession in interface MongoOperations
    
    Type Parameters:
    
    T - return type
    
    Parameters:
    
    action - callback that specified the MongoDB actions to perform on the DB instance
    
    Returns:
    
    a result object returned by the action or null
  - createCollection
```
public <T> com.mongodb.DBCollection createCollection(Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Create an uncapped collection with a name based on the provided entity class.
    
    Specified by:
    
    createCollection in interface MongoOperations
    
    Parameters:
    
    entityClass - class that determines the collection to create
    
    Returns:
    
    the created collection
  - createCollection
```
public <T> com.mongodb.DBCollection createCollection(Class<T> entityClass,
                                                     CollectionOptions collectionOptions)
```
    Description copied from interface: MongoOperations
    
    Create a collect with a name based on the provided entity class using the options.
    
    Specified by:
    
    createCollection in interface MongoOperations
    
    Parameters:
    
    entityClass - class that determines the collection to create
    
    collectionOptions - options to use when creating the collection.
    
    Returns:
    
    the created collection
  - createCollection
```
public com.mongodb.DBCollection createCollection(String collectionName)
```
    Description copied from interface: MongoOperations
    
    Create an uncapped collection with the provided name.
    
    Specified by:
    
    createCollection in interface MongoOperations
    
    Parameters:
    
    collectionName - name of the collection
    
    Returns:
    
    the created collection
  - createCollection
```
public com.mongodb.DBCollection createCollection(String collectionName,
                                                 CollectionOptions collectionOptions)
```
    Description copied from interface: MongoOperations
    
    Create a collect with the provided name and options.
    
    Specified by:
    
    createCollection in interface MongoOperations
    
    Parameters:
    
    collectionName - name of the collection
    
    collectionOptions - options to use when creating the collection.
    
    Returns:
    
    the created collection
  - getCollection
```
public com.mongodb.DBCollection getCollection(String collectionName)
```
    Description copied from interface: MongoOperations
    
    Get a collection by name, creating it if it doesn't exist.
    Translate any exceptions as necessary.
    
    Specified by:
    
    getCollection in interface MongoOperations
    
    Parameters:
    
    collectionName - name of the collection
    
    Returns:
    
    an existing collection or a newly created one.
  - collectionExists
```
public <T> boolean collectionExists(Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Check to see if a collection with a name indicated by the entity class exists.
    Translate any exceptions as necessary.
    
    Specified by:
    
    collectionExists in interface MongoOperations
    
    Parameters:
    
    entityClass - class that determines the name of the collection
    
    Returns:
    
    true if a collection with the given name is found, false otherwise.
  - collectionExists
```
public boolean collectionExists(String collectionName)
```
    Description copied from interface: MongoOperations
    
    Check to see if a collection with a given name exists.
    Translate any exceptions as necessary.
    
    Specified by:
    
    collectionExists in interface MongoOperations
    
    Parameters:
    
    collectionName - name of the collection
    
    Returns:
    
    true if a collection with the given name is found, false otherwise.
  - dropCollection
```
public <T> void dropCollection(Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Drop the collection with the name indicated by the entity class.
    Translate any exceptions as necessary.
    
    Specified by:
    
    dropCollection in interface MongoOperations
    
    Parameters:
    
    entityClass - class that determines the collection to drop/delete.
  - dropCollection
```
public void dropCollection(String collectionName)
```
    Description copied from interface: MongoOperations
    
    Drop the collection with the given name.
    Translate any exceptions as necessary.
    
    Specified by:
    
    dropCollection in interface MongoOperations
    
    Parameters:
    
    collectionName - name of the collection to drop/delete.
  - indexOps
```
public IndexOperations indexOps(String collectionName)
```
    Description copied from interface: MongoOperations
    
    Returns the operations that can be performed on indexes
    
    Specified by:
    
    indexOps in interface MongoOperations
    
    Returns:
    
    index operations on the named collection
  - indexOps
```
public IndexOperations indexOps(Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Returns the operations that can be performed on indexes
    
    Specified by:
    
    indexOps in interface MongoOperations
    
    Returns:
    
    index operations on the named collection associated with the given entity class
  - findOne
```
public <T> T findOne(Query query,
                     Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Map the results of an ad-hoc query on the collection for the entity class to a single instance of an object of the specified type.
    The object is converted from the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    The query is specified as a Query which can be created either using the BasicQuery or the more feature rich Query.
    
    Specified by:
    
    findOne in interface MongoOperations
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification
    
    entityClass - the parameterized type of the returned list.
    
    Returns:
    
    the converted object
  - findOne
```
public <T> T findOne(Query query,
                     Class<T> entityClass,
                     String collectionName)
```
    Description copied from interface: MongoOperations
    
    Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type.
    The object is converted from the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    The query is specified as a Query which can be created either using the BasicQuery or the more feature rich Query.
    
    Specified by:
    
    findOne in interface MongoOperations
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification
    
    entityClass - the parameterized type of the returned list.
    
    collectionName - name of the collection to retrieve the objects from
    
    Returns:
    
    the converted object
  - exists
```
public boolean exists(Query query,
                      Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Determine result of given Query contains at least one element.
    
    Specified by:
    
    exists in interface MongoOperations
    
    Parameters:
    
    query - the Query class that specifies the criteria used to find a record.
    
    entityClass - the parameterized type.
    
    Returns:
  - exists
```
public boolean exists(Query query,
                      String collectionName)
```
    Description copied from interface: MongoOperations
    
    Determine result of given Query contains at least one element.
    
    Specified by:
    
    exists in interface MongoOperations
    
    Parameters:
    
    query - the Query class that specifies the criteria used to find a record.
    
    collectionName - name of the collection to check for objects.
    
    Returns:
  - exists
```
public boolean exists(Query query,
                      Class<?> entityClass,
                      String collectionName)
```
    Description copied from interface: MongoOperations
    
    Determine result of given Query contains at least one element.
    
    Specified by:
    
    exists in interface MongoOperations
    
    Parameters:
    
    query - the Query class that specifies the criteria used to find a record.
    
    entityClass - the parameterized type.
    
    collectionName - name of the collection to check for objects.
    
    Returns:
  - find
```
public <T> List<T> find(Query query,
                        Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Map the results of an ad-hoc query on the collection for the entity class to a List of the specified type.
    The object is converted from the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    The query is specified as a Query which can be created either using the BasicQuery or the more feature rich Query.
    
    Specified by:
    
    find in interface MongoOperations
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification
    
    entityClass - the parameterized type of the returned list.
    
    Returns:
    
    the List of converted objects
  - find
```
public <T> List<T> find(Query query,
                        Class<T> entityClass,
                        String collectionName)
```
    Description copied from interface: MongoOperations
    
    Map the results of an ad-hoc query on the specified collection to a List of the specified type.
    The object is converted from the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    The query is specified as a Query which can be created either using the BasicQuery or the more feature rich Query.
    
    Specified by:
    
    find in interface MongoOperations
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification
    
    entityClass - the parameterized type of the returned list.
    
    collectionName - name of the collection to retrieve the objects from
    
    Returns:
    
    the List of converted objects
  - findById
```
public <T> T findById(Object id,
                      Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Returns a document with the given id mapped onto the given class. The collection the query is ran against will be derived from the given target class as well.
    
    Specified by:
    
    findById in interface MongoOperations
    
    Parameters:
    
    id - the id of the document to return.
    
    entityClass - the type the document shall be converted into.
    
    Returns:
    
    the document with the given id mapped onto the given target class.
  - findById
```
public <T> T findById(Object id,
                      Class<T> entityClass,
                      String collectionName)
```
    Description copied from interface: MongoOperations
    
    Returns the document with the given id from the given collection mapped onto the given target class.
    
    Specified by:
    
    findById in interface MongoOperations
    
    Parameters:
    
    id - the id of the document to return
    
    entityClass - the type to convert the document to
    
    collectionName - the collection to query for the document
    
    Returns:
  - geoNear
```
public <T> GeoResults<T> geoNear(NearQuery near,
                                 Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Returns GeoResults for all entities matching the given NearQuery. Will consider entity mapping information to determine the collection the query is ran against. Note, that MongoDB limits the number of results by default. Make sure to add an explicit limit to the NearQuery if you expect a particular number of results.
    
    Specified by:
    
    geoNear in interface MongoOperations
    
    Parameters:
    
    near - must not be null.
    
    entityClass - must not be null.
    
    Returns:
  - geoNear
```
public <T> GeoResults<T> geoNear(NearQuery near,
                                 Class<T> entityClass,
                                 String collectionName)
```
    Description copied from interface: MongoOperations
    
    Returns GeoResults for all entities matching the given NearQuery. Note, that MongoDB limits the number of results by default. Make sure to add an explicit limit to the NearQuery if you expect a particular number of results.
    
    Specified by:
    
    geoNear in interface MongoOperations
    
    Parameters:
    
    near - must not be null.
    
    entityClass - must not be null.
    
    collectionName - the collection to trigger the query against. If no collection name is given the entity class will be inspected.
    
    Returns:
  - findAndModify
```
public <T> T findAndModify(Query query,
                           Update update,
                           Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Triggers findAndModify to apply provided Update on documents matching Criteria of given Query.
    
    Specified by:
    
    findAndModify in interface MongoOperations
    
    Parameters:
    
    query - the Query class that specifies the Criteria used to find a record and also an optional fields specification.
    
    update - the Update to apply on matching documents.
    
    entityClass - the parameterized type.
    
    Returns:
  - findAndModify
```
public <T> T findAndModify(Query query,
                           Update update,
                           Class<T> entityClass,
                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Triggers findAndModify to apply provided Update on documents matching Criteria of given Query.
    
    Specified by:
    
    findAndModify in interface MongoOperations
    
    Parameters:
    
    query - the Query class that specifies the Criteria used to find a record and also an optional fields specification.
    
    update - the Update to apply on matching documents.
    
    entityClass - the parameterized type.
    
    collectionName - the collection to query.
    
    Returns:
  - findAndModify
```
public <T> T findAndModify(Query query,
                           Update update,
                           FindAndModifyOptions options,
                           Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Triggers findAndModify to apply provided Update on documents matching Criteria of given Query taking FindAndModifyOptions into account.
    
    Specified by:
    
    findAndModify in interface MongoOperations
    
    Parameters:
    
    query - the Query class that specifies the Criteria used to find a record and also an optional fields specification.
    
    update - the Update to apply on matching documents.
    
    options - the FindAndModifyOptions holding additional information.
    
    entityClass - the parameterized type.
    
    Returns:
  - findAndModify
```
public <T> T findAndModify(Query query,
                           Update update,
                           FindAndModifyOptions options,
                           Class<T> entityClass,
                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Triggers findAndModify to apply provided Update on documents matching Criteria of given Query taking FindAndModifyOptions into account.
    
    Specified by:
    
    findAndModify in interface MongoOperations
    
    Parameters:
    
    query - the Query class that specifies the Criteria used to find a record and also an optional fields specification.
    
    update - the Update to apply on matching documents.
    
    options - the FindAndModifyOptions holding additional information.
    
    entityClass - the parameterized type.
    
    collectionName - the collection to query.
    
    Returns:
  - findAndRemove
```
public <T> T findAndRemove(Query query,
                           Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Map the results of an ad-hoc query on the collection for the entity type to a single instance of an object of the specified type. The first document that matches the query is returned and also removed from the collection in the database.
    The object is converted from the MongoDB native representation using an instance of MongoConverter.
    The query is specified as a Query which can be created either using the BasicQuery or the more feature rich Query.
    
    Specified by:
    
    findAndRemove in interface MongoOperations
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification
    
    entityClass - the parameterized type of the returned list.
    
    Returns:
    
    the converted object
  - findAndRemove
```
public <T> T findAndRemove(Query query,
                           Class<T> entityClass,
                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Map the results of an ad-hoc query on the specified collection to a single instance of an object of the specified type. The first document that matches the query is returned and also removed from the collection in the database.
    The object is converted from the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    The query is specified as a Query which can be created either using the BasicQuery or the more feature rich Query.
    
    Specified by:
    
    findAndRemove in interface MongoOperations
    
    Parameters:
    
    query - the query class that specifies the criteria used to find a record and also an optional fields specification
    
    entityClass - the parameterized type of the returned list.
    
    collectionName - name of the collection to retrieve the objects from
    
    Returns:
    
    the converted object
  - count
```
public long count(Query query,
                  Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Returns the number of documents for the given Query by querying the collection of the given entity class.
    
    Specified by:
    
    count in interface MongoOperations
    
    entityClass - must not be null.
    
    Returns:
  - count
```
public long count(Query query,
                  String collectionName)
```
    Description copied from interface: MongoOperations
    
    Returns the number of documents for the given Query querying the given collection. The given Query must solely consist of document field references as we lack type information to map potential property references onto document fields. TO make sure the query gets mapped, use MongoOperations.count(Query, Class, String).
    
    Specified by:
    
    count in interface MongoOperations
    
    collectionName - must not be null or empty.
    
    Returns:
    
    See Also:
    
    MongoOperations.count(Query, Class, String)
  - count
```
public long count(Query query,
                  Class<?> entityClass,
                  String collectionName)
```
    Description copied from interface: MongoOperations
    
    Returns the number of documents for the given Query by querying the given collection using the given entity class to map the given Query.
    
    Specified by:
    
    count in interface MongoOperations
    
    entityClass - must not be null.
    
    collectionName - must not be null or empty.
    
    Returns:
  - insert
```
public void insert(Object objectToSave)
```
    Description copied from interface: MongoOperations
    
    Insert the object into the collection for the entity type of the object to save.
    The object is converted to the MongoDB native representation using an instance of MongoConverter.
    If you object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See Spring's Type Conversion" for more details.
    
    Insert is used to initially store the object into the database. To update an existing object use the save method.
    
    Specified by:
    
    insert in interface MongoOperations
    
    Parameters:
    
    objectToSave - the object to store in the collection.
  - insert
```
public void insert(Object objectToSave,
                   String collectionName)
```
    Description copied from interface: MongoOperations
    
    Insert the object into the specified collection.
    The object is converted to the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    Insert is used to initially store the object into the database. To update an existing object use the save method.
    
    Specified by:
    
    insert in interface MongoOperations
    
    Parameters:
    
    objectToSave - the object to store in the collection
    
    collectionName - name of the collection to store the object in
  - ensureNotIterable
```
protected void ensureNotIterable(Object o)
```
  - prepareCollection
```
protected void prepareCollection(com.mongodb.DBCollection collection)
```
    Prepare the collection before any processing is done using it. This allows a convenient way to apply settings like slaveOk() etc. Can be overridden in sub-classes.
    
    Parameters:
    
    collection -
  - prepareWriteConcern
```
protected com.mongodb.WriteConcern prepareWriteConcern(MongoAction mongoAction)
```
    Prepare the WriteConcern before any processing is done using it. This allows a convenient way to apply custom settings in sub-classes.
    
    Parameters:
    
    writeConcern - any WriteConcern already configured or null
    
    Returns:
    
    The prepared WriteConcern or null
  - doInsert
```
protected <T> void doInsert(String collectionName,
                            T objectToSave,
                            MongoWriter<T> writer)
```
  - insert
```
public void insert(Collection<? extends Object> batchToSave,
                   Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Insert a Collection of objects into a collection in a single batch write to the database.
    
    Specified by:
    
    insert in interface MongoOperations
    
    Parameters:
    
    batchToSave - the list of objects to save.
    
    entityClass - class that determines the collection to use
  - insert
```
public void insert(Collection<? extends Object> batchToSave,
                   String collectionName)
```
    Description copied from interface: MongoOperations
    
    Insert a list of objects into the specified collection in a single batch write to the database.
    
    Specified by:
    
    insert in interface MongoOperations
    
    Parameters:
    
    batchToSave - the list of objects to save.
    
    collectionName - name of the collection to store the object in
  - insertAll
```
public void insertAll(Collection<? extends Object> objectsToSave)
```
    Description copied from interface: MongoOperations
    
    Insert a mixed Collection of objects into a database collection determining the collection name to use based on the class.
    
    Specified by:
    
    insertAll in interface MongoOperations
  - doInsertAll
```
protected <T> void doInsertAll(Collection<? extends T> listToSave,
                               MongoWriter<T> writer)
```
  - doInsertBatch
```
protected <T> void doInsertBatch(String collectionName,
                                 Collection<? extends T> batchToSave,
                                 MongoWriter<T> writer)
```
  - save
```
public void save(Object objectToSave)
```
    Description copied from interface: MongoOperations
    
    Save the object to the collection for the entity type of the object to save. This will perform an insert if the object is not already present, that is an 'upsert'.
    The object is converted to the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    If you object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See Spring's Type Conversion" for more details.
    
    Specified by:
    
    save in interface MongoOperations
    
    Parameters:
    
    objectToSave - the object to store in the collection
  - save
```
public void save(Object objectToSave,
                 String collectionName)
```
    Description copied from interface: MongoOperations
    
    Save the object to the specified collection. This will perform an insert if the object is not already present, that is an 'upsert'.
    The object is converted to the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    If you object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that leverages Type Cobnversion API. See Spring's Type Conversion" for more details.
    
    Specified by:
    
    save in interface MongoOperations
    
    Parameters:
    
    objectToSave - the object to store in the collection
    
    collectionName - name of the collection to store the object in
  - doSave
```
protected <T> void doSave(String collectionName,
                          T objectToSave,
                          MongoWriter<T> writer)
```
  - insertDBObject
```
protected Object insertDBObject(String collectionName,
                                com.mongodb.DBObject dbDoc,
                                Class<?> entityClass)
```
  - insertDBObjectList
```
protected List<org.bson.types.ObjectId> insertDBObjectList(String collectionName,
                                                           List<com.mongodb.DBObject> dbDocList)
```
  - saveDBObject
```
protected Object saveDBObject(String collectionName,
                              com.mongodb.DBObject dbDoc,
                              Class<?> entityClass)
```
  - upsert
```
public com.mongodb.WriteResult upsert(Query query,
                                      Update update,
                                      Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Performs an upsert. If no document is found that matches the query, a new document is created and inserted by combining the query document and the update document.
    
    Specified by:
    
    upsert in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be upserted
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object
    
    entityClass - class that determines the collection to use
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - upsert
```
public com.mongodb.WriteResult upsert(Query query,
                                      Update update,
                                      String collectionName)
```
    Description copied from interface: MongoOperations
    
    Performs an upsert. If no document is found that matches the query, a new document is created and inserted by combining the query document and the update document.
    
    Specified by:
    
    upsert in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be updated
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object.
    
    collectionName - name of the collection to update the object in
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - upsert
```
public com.mongodb.WriteResult upsert(Query query,
                                      Update update,
                                      Class<?> entityClass,
                                      String collectionName)
```
    Description copied from interface: MongoOperations
    
    Performs an upsert. If no document is found that matches the query, a new document is created and inserted by combining the query document and the update document.
    
    Specified by:
    
    upsert in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be upserted
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object
    
    entityClass - class of the pojo to be operated on
    
    collectionName - name of the collection to update the object in
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - updateFirst
```
public com.mongodb.WriteResult updateFirst(Query query,
                                           Update update,
                                           Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Updates the first object that is found in the collection of the entity class that matches the query document with the provided update document.
    
    Specified by:
    
    updateFirst in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be updated
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object.
    
    entityClass - class that determines the collection to use
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - updateFirst
```
public com.mongodb.WriteResult updateFirst(Query query,
                                           Update update,
                                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.
    
    Specified by:
    
    updateFirst in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be updated
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object.
    
    collectionName - name of the collection to update the object in
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - updateFirst
```
public com.mongodb.WriteResult updateFirst(Query query,
                                           Update update,
                                           Class<?> entityClass,
                                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Updates the first object that is found in the specified collection that matches the query document criteria with the provided updated document.
    
    Specified by:
    
    updateFirst in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be updated
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object.
    
    entityClass - class of the pojo to be operated on
    
    collectionName - name of the collection to update the object in
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - updateMulti
```
public com.mongodb.WriteResult updateMulti(Query query,
                                           Update update,
                                           Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.
    
    Specified by:
    
    updateMulti in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be updated
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object.
    
    entityClass - class that determines the collection to use
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - updateMulti
```
public com.mongodb.WriteResult updateMulti(Query query,
                                           Update update,
                                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Updates all objects that are found in the specified collection that matches the query document criteria with the provided updated document.
    
    Specified by:
    
    updateMulti in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be updated
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object.
    
    collectionName - name of the collection to update the object in
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - updateMulti
```
public com.mongodb.WriteResult updateMulti(Query query,
                                           Update update,
                                           Class<?> entityClass,
                                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Updates all objects that are found in the collection for the entity class that matches the query document criteria with the provided updated document.
    
    Specified by:
    
    updateMulti in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to select a record to be updated
    
    update - the update document that contains the updated object or $ operators to manipulate the existing object.
    
    entityClass - class of the pojo to be operated on
    
    collectionName - name of the collection to update the object in
    
    Returns:
    
    the WriteResult which lets you access the results of the previous write.
  - doUpdate
```
protected com.mongodb.WriteResult doUpdate(String collectionName,
                                           Query query,
                                           Update update,
                                           Class<?> entityClass,
                                           boolean upsert,
                                           boolean multi)
```
  - remove
```
public com.mongodb.WriteResult remove(Object object)
```
    Description copied from interface: MongoOperations
    
    Remove the given object from the collection by id.
    
    Specified by:
    
    remove in interface MongoOperations
  - remove
```
public com.mongodb.WriteResult remove(Object object,
                                      String collection)
```
    Description copied from interface: MongoOperations
    
    Removes the given object from the given collection.
    
    Specified by:
    
    remove in interface MongoOperations
    
    collection - must not be null or empty.
  - remove
```
public com.mongodb.WriteResult remove(Query query,
                                      String collectionName)
```
    Description copied from interface: MongoOperations
    
    Remove all documents from the specified collection that match the provided query document criteria. There is no conversion/mapping done for any criteria using the id field.
    
    Specified by:
    
    remove in interface MongoOperations
    
    Parameters:
    
    query - the query document that specifies the criteria used to remove a record
    
    collectionName - name of the collection where the objects will removed
  - remove
```
public com.mongodb.WriteResult remove(Query query,
                                      Class<?> entityClass)
```
    Description copied from interface: MongoOperations
    
    Remove all documents that match the provided query document criteria from the the collection used to store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
    
    Specified by:
    
    remove in interface MongoOperations
  - remove
```
public com.mongodb.WriteResult remove(Query query,
                                      Class<?> entityClass,
                                      String collectionName)
```
    Description copied from interface: MongoOperations
    
    Remove all documents that match the provided query document criteria from the the collection used to store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
    
    Specified by:
    
    remove in interface MongoOperations
  - doRemove
```
protected <T> com.mongodb.WriteResult doRemove(String collectionName,
                                               Query query,
                                               Class<T> entityClass)
```
  - findAll
```
public <T> List<T> findAll(Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Query for a list of objects of type T from the collection used by the entity class.
    The object is converted from the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    If your collection does not contain a homogeneous collection of types, this operation will not be an efficient way to map objects since the test for class type is done in the client and not on the server.
    
    Specified by:
    
    findAll in interface MongoOperations
    
    Parameters:
    
    entityClass - the parameterized type of the returned list
    
    Returns:
    
    the converted collection
  - findAll
```
public <T> List<T> findAll(Class<T> entityClass,
                           String collectionName)
```
    Description copied from interface: MongoOperations
    
    Query for a list of objects of type T from the specified collection.
    The object is converted from the MongoDB native representation using an instance of MongoConverter. Unless configured otherwise, an instance of MappingMongoConverter will be used.
    If your collection does not contain a homogeneous collection of types, this operation will not be an efficient way to map objects since the test for class type is done in the client and not on the server.
    
    Specified by:
    
    findAll in interface MongoOperations
    
    Parameters:
    
    entityClass - the parameterized type of the returned list.
    
    collectionName - name of the collection to retrieve the objects from
    
    Returns:
    
    the converted collection
  - mapReduce
```
public <T> MapReduceResults<T> mapReduce(String inputCollectionName,
                                         String mapFunction,
                                         String reduceFunction,
                                         Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Execute a map-reduce operation. The map-reduce operation will be formed with an output type of INLINE
    
    Specified by:
    
    mapReduce in interface MongoOperations
    
    Parameters:
    
    inputCollectionName - the collection where the map-reduce will read from
    
    mapFunction - The JavaScript map function
    
    reduceFunction - The JavaScript reduce function
    
    entityClass - The parameterized type of the returned list
    
    Returns:
    
    The results of the map reduce operation
  - mapReduce
```
public <T> MapReduceResults<T> mapReduce(String inputCollectionName,
                                         String mapFunction,
                                         String reduceFunction,
                                         MapReduceOptions mapReduceOptions,
                                         Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Execute a map-reduce operation that takes additional map-reduce options.
    
    Specified by:
    
    mapReduce in interface MongoOperations
    
    Parameters:
    
    inputCollectionName - the collection where the map-reduce will read from
    
    mapFunction - The JavaScript map function
    
    reduceFunction - The JavaScript reduce function
    
    mapReduceOptions - Options that specify detailed map-reduce behavior
    
    entityClass - The parameterized type of the returned list
    
    Returns:
    
    The results of the map reduce operation
  - mapReduce
```
public <T> MapReduceResults<T> mapReduce(Query query,
                                         String inputCollectionName,
                                         String mapFunction,
                                         String reduceFunction,
                                         Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Execute a map-reduce operation that takes a query. The map-reduce operation will be formed with an output type of INLINE
    
    Specified by:
    
    mapReduce in interface MongoOperations
    
    Parameters:
    
    query - The query to use to select the data for the map phase
    
    inputCollectionName - the collection where the map-reduce will read from
    
    mapFunction - The JavaScript map function
    
    reduceFunction - The JavaScript reduce function
    
    entityClass - The parameterized type of the returned list
    
    Returns:
    
    The results of the map reduce operation
  - mapReduce
```
public <T> MapReduceResults<T> mapReduce(Query query,
                                         String inputCollectionName,
                                         String mapFunction,
                                         String reduceFunction,
                                         MapReduceOptions mapReduceOptions,
                                         Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Execute a map-reduce operation that takes a query and additional map-reduce options
    
    Specified by:
    
    mapReduce in interface MongoOperations
    
    Parameters:
    
    query - The query to use to select the data for the map phase
    
    inputCollectionName - the collection where the map-reduce will read from
    
    mapFunction - The JavaScript map function
    
    reduceFunction - The JavaScript reduce function
    
    mapReduceOptions - Options that specify detailed map-reduce behavior
    
    entityClass - The parameterized type of the returned list
    
    Returns:
    
    The results of the map reduce operation
  - group
```
public <T> GroupByResults<T> group(String inputCollectionName,
                                   GroupBy groupBy,
                                   Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Execute a group operation over the entire collection. The group operation entity class should match the 'shape' of the returned object that takes int account the initial document structure as well as any finalize functions.
    
    Specified by:
    
    group in interface MongoOperations
    
    Parameters:
    
    inputCollectionName - the collection where the group operation will read from
    
    groupBy - the conditions under which the group operation will be performed, e.g. keys, initial document, reduce function.
    
    entityClass - The parameterized type of the returned list
    
    Returns:
    
    The results of the group operation
  - group
```
public <T> GroupByResults<T> group(Criteria criteria,
                                   String inputCollectionName,
                                   GroupBy groupBy,
                                   Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Execute a group operation restricting the rows to those which match the provided Criteria. The group operation entity class should match the 'shape' of the returned object that takes int account the initial document structure as well as any finalize functions.
    
    Specified by:
    
    group in interface MongoOperations
    
    Parameters:
    
    criteria - The criteria that restricts the row that are considered for grouping. If not specified all rows are considered.
    
    inputCollectionName - the collection where the group operation will read from
    
    groupBy - the conditions under which the group operation will be performed, e.g. keys, initial document, reduce function.
    
    entityClass - The parameterized type of the returned list
    
    Returns:
    
    The results of the group operation
  - aggregate
```
public <O> AggregationResults<O> aggregate(TypedAggregation<?> aggregation,
                                           Class<O> outputType)
```
    Description copied from interface: MongoOperations
    
    Execute an aggregation operation. The raw results will be mapped to the given entity class. The name of the inputCollection is derived from the inputType of the aggregation.
    
    Specified by:
    
    aggregate in interface MongoOperations
    
    Parameters:
    
    aggregation - The TypedAggregation specification holding the aggregation operations, must not be null.
    
    outputType - The parameterized type of the returned list, must not be null.
    
    Returns:
    
    The results of the aggregation operation.
  - aggregate
```
public <O> AggregationResults<O> aggregate(TypedAggregation<?> aggregation,
                                           String inputCollectionName,
                                           Class<O> outputType)
```
    Description copied from interface: MongoOperations
    
    Execute an aggregation operation. The raw results will be mapped to the given entity class. The name of the inputCollection is derived from the inputType of the aggregation.
    
    Specified by:
    
    aggregate in interface MongoOperations
    
    Parameters:
    
    aggregation - The TypedAggregation specification holding the aggregation operations, must not be null.
    
    inputCollectionName - The name of the input collection to use for the aggreation.
    
    outputType - The parameterized type of the returned list, must not be null.
    
    Returns:
    
    The results of the aggregation operation.
  - aggregate
```
public <O> AggregationResults<O> aggregate(Aggregation aggregation,
                                           Class<?> inputType,
                                           Class<O> outputType)
```
    Description copied from interface: MongoOperations
    
    Execute an aggregation operation. The raw results will be mapped to the given entity class.
    
    Specified by:
    
    aggregate in interface MongoOperations
    
    Parameters:
    
    aggregation - The Aggregation specification holding the aggregation operations, must not be null.
    
    inputType - the inputType where the aggregation operation will read from, must not be null or empty.
    
    outputType - The parameterized type of the returned list, must not be null.
    
    Returns:
    
    The results of the aggregation operation.
  - aggregate
```
public <O> AggregationResults<O> aggregate(Aggregation aggregation,
                                           String collectionName,
                                           Class<O> outputType)
```
    Description copied from interface: MongoOperations
    
    Execute an aggregation operation. The raw results will be mapped to the given entity class.
    
    Specified by:
    
    aggregate in interface MongoOperations
    
    Parameters:
    
    aggregation - The Aggregation specification holding the aggregation operations, must not be null.
    
    collectionName - the collection where the aggregation operation will read from, must not be null or empty.
    
    outputType - The parameterized type of the returned list, must not be null.
    
    Returns:
    
    The results of the aggregation operation.
  - findAllAndRemove
```
public <T> List<T> findAllAndRemove(Query query,
                                    String collectionName)
```
    Description copied from interface: MongoOperations
    
    Returns and removes all documents form the specified collection that match the provided query.
    
    Specified by:
    
    findAllAndRemove in interface MongoOperations
    
    Returns:
  - findAllAndRemove
```
public <T> List<T> findAllAndRemove(Query query,
                                    Class<T> entityClass)
```
    Description copied from interface: MongoOperations
    
    Returns and removes all documents matching the given query form the collection used to store the entityClass.
    
    Specified by:
    
    findAllAndRemove in interface MongoOperations
    
    Returns:
  - findAllAndRemove
```
public <T> List<T> findAllAndRemove(Query query,
                                    Class<T> entityClass,
                                    String collectionName)
```
    Description copied from interface: MongoOperations
    
    Returns and removes all documents that match the provided query document criteria from the the collection used to store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
    
    Specified by:
    
    findAllAndRemove in interface MongoOperations
    
    Returns:
  - doFindAndDelete
```
protected <T> List<T> doFindAndDelete(String collectionName,
                                      Query query,
                                      Class<T> entityClass)
```
    Retrieve and remove all documents matching the given query by calling find(Query, Class, String) and remove(Query, Class, String), whereas the Query for remove(Query, Class, String) is constructed out of the find result.
    
    Parameters:
    
    collectionName -
    
    query -
    
    entityClass -
    
    Returns:
  - aggregate
```
protected <O> AggregationResults<O> aggregate(Aggregation aggregation,
                                              String collectionName,
                                              Class<O> outputType,
                                              AggregationOperationContext context)
```
  - replaceWithResourceIfNecessary
```
protected String replaceWithResourceIfNecessary(String function)
```
  - getCollectionNames
```
public Set<String> getCollectionNames()
```
    Description copied from interface: MongoOperations
    
    A set of collection names.
    
    Specified by:
    
    getCollectionNames in interface MongoOperations
    
    Returns:
    
    list of collection names
  - getDb
```
public com.mongodb.DB getDb()
```
  - maybeEmitEvent
```
protected <T> void maybeEmitEvent(MongoMappingEvent<T> event)
```
  - doCreateCollection
```
protected com.mongodb.DBCollection doCreateCollection(String collectionName,
                                                      com.mongodb.DBObject collectionOptions)
```
    Create the specified collection using the provided options
    
    Parameters:
    
    collectionName -
    
    collectionOptions -
    
    Returns:
    
    the collection that was created
  - doFindOne
```
protected <T> T doFindOne(String collectionName,
                          com.mongodb.DBObject query,
                          com.mongodb.DBObject fields,
                          Class<T> entityClass)
```
    Map the results of an ad-hoc query on the default MongoDB collection to an object using the template's converter. The query document is specified as a standard DBObject and so is the fields specification.
    
    Parameters:
    
    collectionName - name of the collection to retrieve the objects from.
    
    query - the query document that specifies the criteria used to find a record.
    
    fields - the document that specifies the fields to be returned.
    
    entityClass - the parameterized type of the returned list.
    
    Returns:
    
    the List of converted objects.
  - doFind
```
protected <T> List<T> doFind(String collectionName,
                             com.mongodb.DBObject query,
                             com.mongodb.DBObject fields,
                             Class<T> entityClass)
```
    Map the results of an ad-hoc query on the default MongoDB collection to a List using the template's converter. The query document is specified as a standard DBObject and so is the fields specification.
    
    Parameters:
    
    collectionName - name of the collection to retrieve the objects from
    
    query - the query document that specifies the criteria used to find a record
    
    fields - the document that specifies the fields to be returned
    
    entityClass - the parameterized type of the returned list.
    
    Returns:
    
    the List of converted objects.
  - doFind
```
protected <T> List<T> doFind(String collectionName,
                             com.mongodb.DBObject query,
                             com.mongodb.DBObject fields,
                             Class<T> entityClass,
                             org.springframework.data.mongodb.core.CursorPreparer preparer)
```
    Map the results of an ad-hoc query on the default MongoDB collection to a List of the specified type. The object is converted from the MongoDB native representation using an instance of MongoConverter. The query document is specified as a standard DBObject and so is the fields specification.
    
    Parameters:
    
    collectionName - name of the collection to retrieve the objects from.
    
    query - the query document that specifies the criteria used to find a record.
    
    fields - the document that specifies the fields to be returned.
    
    entityClass - the parameterized type of the returned list.
    
    preparer - allows for customization of the DBCursor used when iterating over the result set, (apply limits, skips and so on).
    
    Returns:
    
    the List of converted objects.
  - doFind
```
protected <S,T> List<T> doFind(String collectionName,
                               com.mongodb.DBObject query,
                               com.mongodb.DBObject fields,
                               Class<S> entityClass,
                               org.springframework.data.mongodb.core.CursorPreparer preparer,
                               org.springframework.data.mongodb.core.MongoTemplate.DbObjectCallback<T> objectCallback)
```
  - convertToDbObject
```
protected com.mongodb.DBObject convertToDbObject(CollectionOptions collectionOptions)
```
  - doFindAndRemove
```
protected <T> T doFindAndRemove(String collectionName,
                                com.mongodb.DBObject query,
                                com.mongodb.DBObject fields,
                                com.mongodb.DBObject sort,
                                Class<T> entityClass)
```
    Map the results of an ad-hoc query on the default MongoDB collection to an object using the template's converter. The first document that matches the query is returned and also removed from the collection in the database.
    The query document is specified as a standard DBObject and so is the fields specification.
    
    Parameters:
    
    collectionName - name of the collection to retrieve the objects from
    
    query - the query document that specifies the criteria used to find a record
    
    entityClass - the parameterized type of the returned list.
    
    Returns:
    
    the List of converted objects.
  - doFindAndModify
```
protected <T> T doFindAndModify(String collectionName,
                                com.mongodb.DBObject query,
                                com.mongodb.DBObject fields,
                                com.mongodb.DBObject sort,
                                Class<T> entityClass,
                                Update update,
                                FindAndModifyOptions options)
```
  - populateIdIfNecessary
```
protected void populateIdIfNecessary(Object savedObject,
                                     Object id)
```
    Populates the id property of the saved object, if it's not set already.
    
    Parameters:
    
    savedObject -
    
    id -
  - handleAnyWriteResultErrors
```
protected void handleAnyWriteResultErrors(com.mongodb.WriteResult writeResult,
                                          com.mongodb.DBObject query,
                                          MongoActionOperation operation)
```
    Handles WriteResult errors based on the configured WriteResultChecking.
    
    Parameters:
    
    writeResult -
    
    query -
    
    operation -

Class MongoTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MongoTemplate

MongoTemplate

MongoTemplate

MongoTemplate

Method Detail

setWriteResultChecking

setWriteConcern

setWriteConcernResolver

setReadPreference

setApplicationContext

getConverter

getCollectionName

executeCommand

executeCommand

executeCommand

logCommandExecutionError

executeQuery

executeQuery

execute

execute

execute

executeInSession

createCollection

createCollection

createCollection

createCollection

getCollection

collectionExists

collectionExists

dropCollection

dropCollection

indexOps

indexOps

findOne

findOne

exists

exists

exists

find

find

findById

findById

geoNear

geoNear

findAndModify

findAndModify

findAndModify

findAndModify

findAndRemove

findAndRemove

count

count

count

insert

insert

ensureNotIterable

prepareCollection

prepareWriteConcern

doInsert

insert

insert

insertAll

doInsertAll

doInsertBatch

save

save

doSave

insertDBObject

insertDBObjectList

saveDBObject

upsert

upsert

upsert

updateFirst

updateFirst