Package dev.morphia

Class DatastoreImpl

java.lang.Object

dev.morphia.DatastoreImpl

All Implemented Interfaces:

AdvancedDatastore, Datastore

Direct Known Subclasses:

BaseMorphiaSession

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.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DatastoreImpl(com.mongodb.client.MongoClient mongoClient, MapperOptions options, String dbName)
	DatastoreImpl(com.mongodb.client.MongoDatabase database, com.mongodb.client.MongoClient mongoClient, Mapper mapper, QueryFactory queryFactory)	Copy constructor for a datastore

Method Summary

Modifier and Type	Method	Description
<T> Aggregation<T>	aggregate(Class<T> source)	Returns a new query bound to the kind (a specific DBCollection)
Aggregation<org.bson.Document>	aggregate(String source)	Returns a new query bound to the kind (a specific DBCollection)
AggregationPipeline	createAggregation(Class source)	Returns a new query bound to the kind (a specific DBCollection)
AggregationPipeline	createAggregation(String collection, Class<?> clazz)	Returns an AggregationPipeline bound to the given collection and class.
<T> com.mongodb.client.result.DeleteResult	delete(T entity)	Deletes the given entity (by @Id)
<T> com.mongodb.client.result.DeleteResult	delete(T entity, DeleteOptions options)	Deletes the given entity (by @Id), with the WriteConcern
void	enableDocumentValidation()	Process any Validation annotations for document 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> clazz)	Ensures (creating if necessary) the indexes found during class mapping
<T> Query<T>	find(Class<T> type)	Find all instances by type
<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
com.mongodb.client.ClientSession	findSession(dev.morphia.internal.SessionConfigurable<?> configurable)
<T,V> Query<T>	get(Class<T> clazz, Iterable<V> ids)	Find the given entities (by id); shorthand for find("_id in", ids)
<T> T	getByKey(Class<T> clazz, Key<T> key)	Find the given entity (by collectionName/id);
<T> List<T>	getByKeys(Class<T> clazz, Iterable<Key<T>> keys)	Find the given entities (by id), verifying they are of the correct type; shorthand for find("_id in", ids)
<T> List<T>	getByKeys(Iterable<Key<T>> keys)	Find the given entities (by id); shorthand for find("_id in", ids)
com.mongodb.client.MongoDatabase	getDatabase()
<T> Key<T>	getKey(T entity)	Deprecated.
String	getLoggedQuery(FindOptions options)
Mapper	getMapper()
QueryFactory	getQueryFactory()
protected <T> void	insert(com.mongodb.client.MongoCollection collection, T entity, InsertOneOptions options)
<T> void	insert(List<T> entities, InsertManyOptions options)	Inserts entities in to the mapped collection.
<T> void	insert(T entity)	Inserts an entity 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.
<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>	save(List<T> entities, InsertManyOptions options)	Saves the entities (Objects) and updates the @Id field
<T> T	save(T entity)	Saves an entity (Object) and updates the @Id field
<T> T	save(T entity, InsertOneOptions options)	Saves an entity (Object) and updates the @Id field
protected <T> void	saveDocument(T entity, com.mongodb.client.MongoCollection<T> collection, InsertOneOptions options)
void	setQueryFactory(QueryFactory queryFactory)	Replaces the current QueryFactory with the given value.
MorphiaSession	startSession()	Starts a new session on the server.
MorphiaSession	startSession(com.mongodb.ClientSessionOptions options)	Starts a new session on the server.
<T> T	withTransaction(com.mongodb.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

createQuery, createQuery, createRef, createRef, createUpdateOperations, insert, insert

Methods inherited from interface dev.morphia.Datastore

createQuery, createUpdateOperations, delete, delete, findAndDelete, findAndDelete, findAndModify, findAndModify, get, getSession, insert, merge, save, save, save, save, update, update

Constructor Detail

DatastoreImpl

protected DatastoreImpl(com.mongodb.client.MongoClient mongoClient,
                        MapperOptions options,
                        String dbName)

DatastoreImpl

public DatastoreImpl(com.mongodb.client.MongoDatabase database,
                     com.mongodb.client.MongoClient mongoClient,
                     Mapper mapper,
                     QueryFactory queryFactory)

Copy constructor for a datastore

Parameters:

database - the database

mongoClient - the client

mapper - the mapper

queryFactory - the query factory

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

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

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

insert

public <T> void insert(T entity)

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

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

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.

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

insert

protected <T> void insert(com.mongodb.client.MongoCollection collection,
                          T entity,
                          InsertOneOptions options)

findSession

public com.mongodb.client.ClientSession findSession(dev.morphia.internal.SessionConfigurable<?> configurable)

Specified by:

findSession in interface Datastore

Parameters:

configurable - the configurable

Returns:

any session found first on the configurable then on this

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

startSession

public MorphiaSession 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 MorphiaSession startSession(com.mongodb.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

withTransaction

public <T> T withTransaction(com.mongodb.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

aggregate

public Aggregation<org.bson.Document> aggregate(String source)

Description copied from interface: Datastore

Returns a new query bound to the kind (a specific DBCollection)

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 DBCollection)

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 DBCollection)

Specified by:

createAggregation in interface Datastore

Parameters:

source - The class to create aggregation against

Returns:

the aggregation pipeline

find

public <T> Query<T> find(Class<T> type)

Description copied from interface: Datastore

Find all instances by 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(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

getMapper

public Mapper getMapper()

Specified by:

getMapper in interface Datastore

Returns:

the Mapper used by this Datastore

delete

public <T> com.mongodb.client.result.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

delete

public <T> com.mongodb.client.result.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

ensureCaps

public void ensureCaps()

Description copied from interface: Datastore

ensure capped collections for Entity(s)

Specified by:

ensureCaps in interface Datastore

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> clazz)

Description copied from interface: Datastore

Ensures (creating if necessary) the indexes found during class mapping

Specified by:

ensureIndexes in interface Datastore

Type Parameters:

T - the type to index

Parameters:

clazz - the class from which to get the index definitions

See Also:

Indexes, Indexed, Text

get

public <T,V> Query<T> get(Class<T> clazz,
                                Iterable<V> ids)

Description copied from interface: Datastore

Find the given entities (by id); shorthand for find("_id in", ids)

Specified by:

get in interface Datastore

Type Parameters:

T - the type to fetch

V - the type of the ID

Parameters:

clazz - the class to use for mapping

ids - the IDs to query

Returns:

the query to find the entities

getByKey

public <T> T getByKey(Class<T> clazz,
                      Key<T> key)

Description copied from interface: Datastore

Find the given entity (by collectionName/id);

Specified by:

getByKey in interface Datastore

Type Parameters:

T - the type to fetch

Parameters:

clazz - the class to use for mapping

key - the key search with

Returns:

the matched entity. may be null.

getByKeys

public <T> List<T> getByKeys(Class<T> clazz,
                             Iterable<Key<T>> keys)

Description copied from interface: Datastore

Find the given entities (by id), verifying they are of the correct type; shorthand for find("_id in", ids)

Specified by:

getByKeys in interface Datastore

Type Parameters:

T - the type to fetch

Parameters:

clazz - the class to use for mapping

keys - the keys to search with

Returns:

the matched entities. may be null.

getByKeys

public <T> List<T> getByKeys(Iterable<Key<T>> keys)

Description copied from interface: Datastore

Find the given entities (by id); shorthand for find("_id in", ids)

Specified by:

getByKeys in interface Datastore

Type Parameters:

T - the type to fetch

Parameters:

keys - the keys to search with

Returns:

the matched entities. may be null.

getDatabase

public com.mongodb.client.MongoDatabase getDatabase()

Specified by:

getDatabase in interface Datastore

Returns:

the MongoDatabase used by this DataStore

getKey

@Deprecated
public <T> Key<T> getKey(T entity)

Deprecated.

Description copied from interface: Datastore

Creates a (type-safe) reference to the entity; if stored this will become a DBRef

Specified by:

getKey in interface Datastore

Type Parameters:

T - the type of the entity

Parameters:

entity - the entity whose key is to be returned

Returns:

the Key

getQueryFactory

public QueryFactory getQueryFactory()

Specified by:

getQueryFactory in interface Datastore

Returns:

the current QueryFactory.

See Also:

QueryFactory

setQueryFactory

public void setQueryFactory(QueryFactory queryFactory)

Description copied from interface: Datastore

Replaces the current QueryFactory with the given value.

Specified by:

setQueryFactory in interface Datastore

Parameters:

queryFactory - the QueryFactory to use

See Also:

QueryFactory

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.

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.

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

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

save

public <T> T save(T entity)

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

Returns:

the saved entity

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

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

saveDocument

protected <T> void saveDocument(T entity,
                                com.mongodb.client.MongoCollection<T> collection,
                                InsertOneOptions options)

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