java.lang.Object
- dev.morphia.DatastoreImpl

All Implemented Interfaces:

AdvancedDatastore, Datastore

Direct Known Subclasses:

MorphiaSessionImpl
```
@MorphiaInternal
public class DatastoreImpl
extends Object
implements AdvancedDatastore
```
A generic (type-safe) wrapper around mongodb collections

Developer note.
This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DatastoreImpl.DatastoreOperations

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`DatastoreImpl(DatastoreImpl datastore)`	Copy constructor for a datastore
`protected`	`DatastoreImpl(Mapper mapper, MongoClient mongoClient, String dbName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<T> Aggregation<T>`	`aggregate(Class<T> source)`	Returns a new query bound to the kind (a specific `MongoCollection`)
`Aggregation<Document>`	`aggregate(String source)`	Returns a new query bound to the kind (a specific `MongoCollection`)
`<T> MongoCollection<T>`	`configureCollection(dev.morphia.internal.CollectionConfiguration options, MongoCollection<T> collection)`	Applies configuration options to the collection
`AggregationPipeline`	`createAggregation(Class source)`	Returns a new query bound to the kind (a specific `MongoCollection`)
`AggregationPipeline`	`createAggregation(String collection, Class<?> clazz)`	Returns an `AggregationPipeline` bound to the given collection and class.
`<T> Query<T>`	`createQuery(Class<T> type, Document q)`
`<T> UpdateOperations<T>`	`createUpdateOperations(Class<T> clazz)`	The builder for all update operations
`<T> DeleteResult`	`delete(T entity)`	Deletes the given entity (by @Id)
`<T> DeleteResult`	`delete(T entity, DeleteOptions options)`	Deletes the given entity (by @Id), with the WriteConcern
`protected <T> T`	`doTransaction(MorphiaSessionImpl morphiaSession, MorphiaTransaction<T> body)`
`void`	`enableDocumentValidation()`	Process any `Validation` annotations for document validation.
`void`	`enableValidation(EntityModel model, Validation validation)`
`void`	`ensureCaps()`	ensure capped collections for `Entity`(s)
`void`	`ensureIndexes()`	Ensures (creating if necessary) the indexes found during class mapping
`<T> void`	`ensureIndexes(Class<T> type)`
`<T> Query<T>`	`find(Class<T> type)`	Find instances of a type
`<T> Query<T>`	`find(Class<T> type, Document nativeQuery)`	Find instances of a type using a native query.
`<T> Query<T>`	`find(String collection)`	Find all instances by type in a different collection than what is mapped on the class given.
`<T> Query<T>`	`find(String collection, Class<T> type)`	Find all instances by type from an alternate collection
`CodecRegistry`	`getCodecRegistry()`
`<T> MongoCollection<T>`	`getCollection(Class<T> type)`
`MongoDatabase`	`getDatabase()`
`String`	`getLoggedQuery(FindOptions options)`
`Mapper`	`getMapper()`
`protected MongoClient`	`getMongoClient()`
`<T> void`	`insert(List<T> entities, InsertManyOptions options)`	Inserts entities in to the mapped collection.
`<T> void`	`insert(T entity, InsertOneOptions options)`	Inserts an entity in to the mapped collection.
`<T> T`	`merge(T entity)`	Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
`<T> T`	`merge(T entity, InsertOneOptions options)`	Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
`DatastoreImpl.DatastoreOperations`	`operations()`
`protected DatastoreImpl`	`operations(DatastoreImpl.DatastoreOperations operations)`
`<T> Query<T>`	`queryByExample(String collection, T ex)`	Returns a new query based on the example object
`<T> Query<T>`	`queryByExample(T example)`	Returns a new query based on the example object
`<T> void`	`refresh(T entity)`	Refreshes an existing entity to its current state in the database.
`<T> List<T>`	`replace(List<T> entities, ReplaceOptions options)`	Replaces a list of documents in the database
`<T> T`	`replace(T entity, ReplaceOptions options)`	Replaces a document in the database
`<T> List<T>`	`save(List<T> entities, InsertManyOptions options)`	Saves the entities (Objects) and updates the @Id field
`<T> T`	`save(T entity, InsertOneOptions options)`	Saves an entity (Object) and updates the @Id field
`protected Document`	`shardCollection(EntityModel model)`
`void`	`shardCollections()`	Shards any collections with sharding definitions.
`MorphiaSessionImpl`	`startSession()`	Starts a new session on the server.
`MorphiaSessionImpl`	`startSession(ClientSessionOptions options)`	Starts a new session on the server.
`<T> T`	`withTransaction(ClientSessionOptions options, MorphiaTransaction<T> transaction)`
`<T> T`	`withTransaction(MorphiaTransaction<T> body)`

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

Methods inherited from interface dev.morphia.AdvancedDatastore
createRef, createRef, createUpdateOperations, insert, insert

Methods inherited from interface dev.morphia.Datastore
createQuery, delete, delete, findAndDelete, findAndDelete, findAndModify, findAndModify, insert, insert, merge, replace, replace, save, save, save, save, save, update, update

- Constructor Detail
  - DatastoreImpl
```
protected DatastoreImpl(Mapper mapper,
                        MongoClient mongoClient,
                        String dbName)
```
  - DatastoreImpl
```
protected DatastoreImpl(DatastoreImpl datastore)
```
    Copy constructor for a datastore
    
    Parameters:
    
    datastore - the datastore to clone
    
    Since:
    
    2.0
    
    Developer note.
    This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
- Method Detail
  - insert
```
public <T> void insert(T entity,
                       InsertOneOptions options)
```
    Description copied from interface: Datastore
    
    Inserts an entity in to the mapped collection.
    
    Specified by:
    
    insert in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entity - the entity to insert
    
    options - the options to apply to the insert operation
  - insert
```
public <T> void insert(List<T> entities,
                       InsertManyOptions options)
```
    Description copied from interface: Datastore
    
    Inserts entities in to the mapped collection.
    
    Specified by:
    
    insert in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entities - the entities to insert
    
    options - the options to apply to the insert operation
  - aggregate
```
public Aggregation<Document> aggregate(String source)
```
    Description copied from interface: Datastore
    
    Returns a new query bound to the kind (a specific MongoCollection)
    
    Specified by:
    
    aggregate in interface Datastore
    
    Parameters:
    
    source - The collection aggregation against
    
    Returns:
    
    the aggregation pipeline
  - aggregate
```
public <T> Aggregation<T> aggregate(Class<T> source)
```
    Description copied from interface: Datastore
    
    Returns a new query bound to the kind (a specific MongoCollection)
    
    Specified by:
    
    aggregate in interface Datastore
    
    Type Parameters:
    
    T - the source type
    
    Parameters:
    
    source - The class to create aggregation against
    
    Returns:
    
    the aggregation pipeline
  - createAggregation
```
public AggregationPipeline createAggregation(Class source)
```
    Description copied from interface: Datastore
    
    Returns a new query bound to the kind (a specific MongoCollection)
    
    Specified by:
    
    createAggregation in interface Datastore
    
    Parameters:
    
    source - The class to create aggregation against
    
    Returns:
    
    the aggregation pipeline
  - createUpdateOperations
```
public <T> UpdateOperations<T> createUpdateOperations(Class<T> clazz)
```
    Description copied from interface: Datastore
    
    The builder for all update operations
    
    Specified by:
    
    createUpdateOperations in interface Datastore
    
    Type Parameters:
    
    T - the type to update
    
    Parameters:
    
    clazz - the type to update
    
    Returns:
    
    the new UpdateOperations instance
  - configureCollection
```
@NonNull
@MorphiaInternal
public <T> MongoCollection<T> configureCollection(dev.morphia.internal.CollectionConfiguration options,
                                                  MongoCollection<T> collection)
```
    Applies configuration options to the collection
    
    Type Parameters:
    
    T - the collection type
    
    Parameters:
    
    options - the options to apply
    
    collection - the collection to configure
    
    Returns:
    
    the configured collection
    
    Developer note.
    This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
  - delete
```
public <T> DeleteResult delete(T entity,
                               DeleteOptions options)
```
    Deletes the given entity (by @Id), with the WriteConcern
    
    Specified by:
    
    delete in interface Datastore
    
    Type Parameters:
    
    T - the type to delete
    
    Parameters:
    
    entity - the entity to delete
    
    options - the options to use when deleting
    
    Returns:
    
    results of the delete
  - delete
```
public <T> DeleteResult delete(T entity)
```
    Description copied from interface: Datastore
    
    Deletes the given entity (by @Id)
    
    Specified by:
    
    delete in interface Datastore
    
    Type Parameters:
    
    T - the type to delete
    
    Parameters:
    
    entity - the entity to delete
    
    Returns:
    
    results of the delete
  - enableDocumentValidation
```
public void enableDocumentValidation()
```
    Description copied from interface: Datastore
    
    Process any Validation annotations for document validation.
    
    Specified by:
    
    enableDocumentValidation in interface Datastore
  - ensureIndexes
```
public void ensureIndexes()
```
    Description copied from interface: Datastore
    
    Ensures (creating if necessary) the indexes found during class mapping
    
    Specified by:
    
    ensureIndexes in interface Datastore
    
    See Also:
    
    Indexes, Indexed, Text
  - ensureIndexes
```
public <T> void ensureIndexes(Class<T> type)
```
  - find
```
public <T> Query<T> find(Class<T> type)
```
    Description copied from interface: Datastore
    
    Find instances of a type
    
    Specified by:
    
    find in interface Datastore
    
    Type Parameters:
    
    T - the type to query
    
    Parameters:
    
    type - the class to use for mapping the results
    
    Returns:
    
    the query
  - find
```
public <T> Query<T> find(Class<T> type,
                         Document nativeQuery)
```
    Description copied from interface: Datastore
    
    Find instances of a type using a native query. This method is intended as an aid when copying queries from external sources such as the shell or Compass whose structure is already in json form.
    
    Specified by:
    
    find in interface Datastore
    
    Type Parameters:
    
    T - the type to query
    
    Parameters:
    
    type - the class to use for mapping the results
    
    nativeQuery - the full query structure to use for this Query
    
    Returns:
    
    the query
  - find
```
public <T> Query<T> find(String collection,
                         Class<T> type)
```
    Description copied from interface: Datastore
    
    Find all instances by type from an alternate collection
    
    Specified by:
    
    find in interface Datastore
    
    Type Parameters:
    
    T - the type to query
    
    Parameters:
    
    collection - the actual collection to query. This overrides any mapped on collection on type.
    
    type - the class to use for mapping the results
    
    Returns:
    
    the query
  - find
```
public <T> Query<T> find(String collection)
```
    Description copied from interface: Datastore
    
    Find all instances by type in a different collection than what is mapped on the class given.
    
    Specified by:
    
    find in interface Datastore
    
    Type Parameters:
    
    T - the type to query
    
    Parameters:
    
    collection - the collection to query against
    
    Returns:
    
    the query
  - getCodecRegistry
```
public CodecRegistry getCodecRegistry()
```
    Specified by:
    
    getCodecRegistry in interface Datastore
    
    Returns:
    
    the codec registry
  - getCollection
```
public <T> MongoCollection<T> getCollection(Class<T> type)
```
    Specified by:
    
    getCollection in interface Datastore
    
    Type Parameters:
    
    T - the class type
    
    Parameters:
    
    type - the type look up
    
    Returns:
    
    the collection mapped for this class
  - getDatabase
```
public MongoDatabase getDatabase()
```
    Specified by:
    
    getDatabase in interface Datastore
    
    Returns:
    
    the MongoDatabase used by this DataStore
  - getLoggedQuery
```
public String getLoggedQuery(FindOptions options)
```
    Specified by:
    
    getLoggedQuery in interface Datastore
    
    Parameters:
    
    options - the options used when requesting logging
    
    Returns:
    
    the logged query
    
    Developer note.
    This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
  - replace
```
public <T> T replace(T entity,
                     ReplaceOptions options)
```
    Description copied from interface: Datastore
    
    Replaces a document in the database
    
    Specified by:
    
    replace in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entity - the entity to replace
    
    options - the options to apply to the replace operation
    
    Returns:
    
    the replaced entity
  - ensureCaps
```
public void ensureCaps()
```
    Description copied from interface: Datastore
    
    ensure capped collections for Entity(s)
    
    Specified by:
    
    ensureCaps in interface Datastore
  - merge
```
public <T> T merge(T entity,
                   InsertOneOptions options)
```
    Description copied from interface: Datastore
    
    Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
    
    Specified by:
    
    merge in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entity - the entity to merge back in to the database
    
    options - the options to apply
    
    Returns:
    
    the new merged entity. NOTE: this is a database fetch.
  - getMongoClient
```
protected MongoClient getMongoClient()
```
  - getMapper
```
public Mapper getMapper()
```
    Specified by:
    
    getMapper in interface Datastore
    
    Returns:
    
    the Mapper used by this Datastore
  - shardCollections
```
public void shardCollections()
```
    Description copied from interface: Datastore
    
    Shards any collections with sharding definitions.
    
    Specified by:
    
    shardCollections in interface Datastore
  - merge
```
public <T> T merge(T entity)
```
    Description copied from interface: Datastore
    
    Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
    
    Specified by:
    
    merge in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entity - the entity to merge back in to the database
    
    Returns:
    
    the new merged entity. NOTE: this is a database fetch.
  - shardCollection
```
protected Document shardCollection(EntityModel model)
```
  - save
```
public <T> List<T> save(List<T> entities,
                        InsertManyOptions options)
```
    Description copied from interface: Datastore
    
    Saves the entities (Objects) and updates the @Id field
    
    Specified by:
    
    save in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entities - the entities to save
    
    options - the options to apply to the save operation
    
    Returns:
    
    the saved entities
  - queryByExample
```
public <T> Query<T> queryByExample(T example)
```
    Description copied from interface: Datastore
    
    Returns a new query based on the example object
    
    Specified by:
    
    queryByExample in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    example - the example entity to use when creating the query
    
    Returns:
    
    the query
  - refresh
```
public <T> void refresh(T entity)
```
    Description copied from interface: Datastore
    
    Refreshes an existing entity to its current state in the database. Essentially, any existing mapped state is replaced by the latest persisted state while preserving the entity's reference and object identity.
    
    Specified by:
    
    refresh in interface Datastore
    
    Type Parameters:
    
    T - the entity type
    
    Parameters:
    
    entity - the entity to refresh
  - startSession
```
public MorphiaSessionImpl startSession()
```
    Description copied from interface: Datastore
    
    Starts a new session on the server.
    
    Specified by:
    
    startSession in interface Datastore
    
    Returns:
    
    the new session reference
  - startSession
```
public MorphiaSessionImpl startSession(ClientSessionOptions options)
```
    Description copied from interface: Datastore
    
    Starts a new session on the server.
    
    Specified by:
    
    startSession in interface Datastore
    
    Parameters:
    
    options - the options to apply
    
    Returns:
    
    the new session reference
  - save
```
public <T> T save(T entity,
                  InsertOneOptions options)
```
    Description copied from interface: Datastore
    
    Saves an entity (Object) and updates the @Id field
    
    Specified by:
    
    save in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entity - the entity to save
    
    options - the options to apply to the save operation
    
    Returns:
    
    the saved entity
  - operations
```
public DatastoreImpl.DatastoreOperations operations()
```
  - doTransaction
```
protected <T> T doTransaction(MorphiaSessionImpl morphiaSession,
                              MorphiaTransaction<T> body)
```
  - withTransaction
```
public <T> T withTransaction(MorphiaTransaction<T> body)
```
    Specified by:
    
    withTransaction in interface Datastore
    
    Type Parameters:
    
    T - the return type
    
    Parameters:
    
    body - the transaction wrapper
    
    Returns:
    
    the return value
  - withTransaction
```
public <T> T withTransaction(ClientSessionOptions options,
                             MorphiaTransaction<T> transaction)
```
    Specified by:
    
    withTransaction in interface Datastore
    
    Type Parameters:
    
    T - the return type
    
    Parameters:
    
    options - the session options to apply
    
    transaction - the transaction wrapper
    
    Returns:
    
    the return value
  - replace
```
public <T> List<T> replace(List<T> entities,
                           ReplaceOptions options)
```
    Description copied from interface: Datastore
    
    Replaces a list of documents in the database
    
    Specified by:
    
    replace in interface Datastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    entities - the entities to replace
    
    options - the options to apply to the replace operation
    
    Returns:
    
    the saved entities
  - createAggregation
```
public AggregationPipeline createAggregation(String collection,
                                             Class<?> clazz)
```
    Description copied from interface: AdvancedDatastore
    
    Returns an AggregationPipeline bound to the given collection and class.
    
    Specified by:
    
    createAggregation in interface AdvancedDatastore
    
    Parameters:
    
    collection - the collection to query
    
    clazz - The class to create aggregation against
    
    Returns:
    
    the aggregation pipeline
    
    See Also:
    
    Aggregation, AggregationOptions
  - createQuery
```
public <T> Query<T> createQuery(Class<T> type,
                                Document q)
```
    Specified by:
    
    createQuery in interface AdvancedDatastore
    
    Type Parameters:
    
    T - The type of the entity
    
    Parameters:
    
    type - the class of objects to be returned
    
    q - the query which will be passed to a QueryFactory
    
    Returns:
    
    Query for the specified class type
  - queryByExample
```
public <T> Query<T> queryByExample(String collection,
                                   T ex)
```
    Description copied from interface: AdvancedDatastore
    
    Returns a new query based on the example object
    
    Specified by:
    
    queryByExample in interface AdvancedDatastore
    
    Type Parameters:
    
    T - the type of the entity
    
    Parameters:
    
    collection - the collection to query
    
    ex - the example entity to use when building the query
    
    Returns:
    
    the query
  - enableValidation
```
@MorphiaInternal
public void enableValidation(EntityModel model,
                             Validation validation)
```
    Parameters:
    
    model - internal
    
    validation - internal
    
    Developer note.
    This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
  - operations
```
protected DatastoreImpl operations(DatastoreImpl.DatastoreOperations operations)
```

Class DatastoreImpl

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface dev.morphia.AdvancedDatastore

Methods inherited from interface dev.morphia.Datastore

Constructor Detail

DatastoreImpl

DatastoreImpl

Method Detail

insert

insert

aggregate

aggregate

createAggregation

createUpdateOperations

configureCollection

delete

delete

enableDocumentValidation

ensureIndexes

ensureIndexes

find

find

find

find

getCodecRegistry

getCollection

getDatabase

getLoggedQuery

replace

ensureCaps

merge

getMongoClient

getMapper

shardCollections

merge

shardCollection

save

queryByExample

refresh

startSession

startSession

save

operations

doTransaction

withTransaction

withTransaction

replace

createAggregation

createQuery

queryByExample

enableValidation

operations