org.hibernate.ogm.datastore.mongodb

Class MongoDBDialect

java.lang.Object

org.hibernate.ogm.dialect.spi.BaseGridDialect

org.hibernate.ogm.datastore.mongodb.MongoDBDialect

All Implemented Interfaces:

Serializable, BatchableGridDialect, IdentityColumnAwareGridDialect, MultigetGridDialect, OptimisticLockingAwareGridDialect, QueryableGridDialect<MongoDBQueryDescriptor>, GridDialect, org.hibernate.service.Service

public class MongoDBDialect
extends BaseGridDialect
implements QueryableGridDialect<MongoDBQueryDescriptor>, BatchableGridDialect, IdentityColumnAwareGridDialect, MultigetGridDialect, OptimisticLockingAwareGridDialect

Each Tuple entry is stored as a property in a MongoDB document. Each association is stored in an association document containing three properties: - the association table name (optionally) - the RowKey column names and values - the tuples as an array of elements Associations can be stored as: - one MongoDB collection per association class. The collection name is prefixed. - one MongoDB collection for all associations (the association table name property in then used) - embed the collection info in the owning entity document is planned but not supported at the moment (OGM-177) Collection of embeddable are stored within the owning entity document under the unqualified collection role In MongoDB is possible to batch operations but only for the creation of new documents and only if they don't have invalid characters in the field name. If these conditions are not met, the MongoDB mechanism for batch operations is not going to be used.

Author:

Guillaume Scheibel <guillaume.scheibel@gmail.com>, Alan Fitton <alan at eth0.org.uk>, Emmanuel Bernard <emmanuel@hibernate.org>, Thorsten Möller <thorsten.moeller@sbi.ch>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSOCIATIONS_COLLECTION_PREFIX
static String	ID_FIELDNAME
static String	PROPERTY_SEPARATOR
static String	ROWS_FIELDNAME
static String	TABLE_FIELDNAME

Constructor Summary

Constructors

Constructor and Description
MongoDBDialect(MongoDBDatastoreProvider provider)

Method Summary

Modifier and Type	Method and Description
Association	createAssociation(AssociationKey key, AssociationContext associationContext)
Tuple	createTuple(EntityKeyMetadata entityKeyMetadata, TupleContext tupleContext)
Tuple	createTuple(EntityKey key, TupleContext tupleContext)
ClosableIterator<Tuple>	executeBackendQuery(BackendQuery<MongoDBQueryDescriptor> backendQuery, QueryParameters queryParameters)
int	executeBackendUpdateQuery(BackendQuery<MongoDBQueryDescriptor> backendQuery, QueryParameters queryParameters)
void	executeBatch(OperationsQueue queue)
void	forEachTuple(ModelConsumer consumer, TupleContext tupleContext, EntityKeyMetadata entityKeyMetadata)
Association	getAssociation(AssociationKey key, AssociationContext associationContext)
DuplicateInsertPreventionStrategy	getDuplicateInsertPreventionStrategy(EntityKeyMetadata entityKeyMetadata)
ParameterMetadataBuilder	getParameterMetadataBuilder()
Tuple	getTuple(EntityKey key, TupleContext tupleContext)
List<Tuple>	getTuples(EntityKey[] keys, TupleContext tupleContext)
void	insertOrUpdateAssociation(AssociationKey key, Association association, AssociationContext associationContext)
void	insertOrUpdateTuple(EntityKey key, Tuple tuple, TupleContext tupleContext)
void	insertTuple(EntityKeyMetadata entityKeyMetadata, Tuple tuple, TupleContext tupleContext)
boolean	isStoredInEntityStructure(AssociationKeyMetadata associationKeyMetadata, AssociationTypeContext associationTypeContext)
Number	nextValue(NextValueRequest request)
GridType	overrideType(org.hibernate.type.Type type)
MongoDBQueryDescriptor	parseNativeQuery(String nativeQuery)
void	removeAssociation(AssociationKey key, AssociationContext associationContext)
void	removeTuple(EntityKey key, TupleContext tupleContext)
boolean	removeTupleWithOptimisticLock(EntityKey entityKey, Tuple oldLockState, TupleContext tupleContext)
boolean	updateTupleWithOptimisticLock(EntityKey entityKey, Tuple oldLockState, Tuple tuple, TupleContext tupleContext)

Methods inherited from class org.hibernate.ogm.dialect.spi.BaseGridDialect

getLockingStrategy, supportsSequences

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.ogm.dialect.spi.GridDialect

getLockingStrategy, supportsSequences

Field Detail

ID_FIELDNAME

public static final String ID_FIELDNAME

See Also:

Constant Field Values

PROPERTY_SEPARATOR

public static final String PROPERTY_SEPARATOR

See Also:

Constant Field Values

ROWS_FIELDNAME

public static final String ROWS_FIELDNAME

See Also:

Constant Field Values

TABLE_FIELDNAME

public static final String TABLE_FIELDNAME

See Also:

Constant Field Values

ASSOCIATIONS_COLLECTION_PREFIX

public static final String ASSOCIATIONS_COLLECTION_PREFIX

See Also:

Constant Field Values

Constructor Detail

MongoDBDialect

public MongoDBDialect(MongoDBDatastoreProvider provider)

Method Detail

getTuple

public Tuple getTuple(EntityKey key,
                      TupleContext tupleContext)

Specified by:

getTuple in interface GridDialect

getTuples

public List<Tuple> getTuples(EntityKey[] keys,
                             TupleContext tupleContext)

Specified by:

getTuples in interface MultigetGridDialect

createTuple

public Tuple createTuple(EntityKeyMetadata entityKeyMetadata,
                         TupleContext tupleContext)

Specified by:

createTuple in interface IdentityColumnAwareGridDialect

createTuple

public Tuple createTuple(EntityKey key,
                         TupleContext tupleContext)

Specified by:

createTuple in interface GridDialect

insertOrUpdateTuple

public void insertOrUpdateTuple(EntityKey key,
                                Tuple tuple,
                                TupleContext tupleContext)

Specified by:

insertOrUpdateTuple in interface GridDialect

updateTupleWithOptimisticLock

public boolean updateTupleWithOptimisticLock(EntityKey entityKey,
                                             Tuple oldLockState,
                                             Tuple tuple,
                                             TupleContext tupleContext)

Specified by:

updateTupleWithOptimisticLock in interface OptimisticLockingAwareGridDialect

insertTuple

public void insertTuple(EntityKeyMetadata entityKeyMetadata,
                        Tuple tuple,
                        TupleContext tupleContext)

Specified by:

insertTuple in interface IdentityColumnAwareGridDialect

removeTuple

public void removeTuple(EntityKey key,
                        TupleContext tupleContext)

Specified by:

removeTuple in interface GridDialect

removeTupleWithOptimisticLock

public boolean removeTupleWithOptimisticLock(EntityKey entityKey,
                                             Tuple oldLockState,
                                             TupleContext tupleContext)

Specified by:

removeTupleWithOptimisticLock in interface OptimisticLockingAwareGridDialect

getAssociation

public Association getAssociation(AssociationKey key,
                                  AssociationContext associationContext)

Specified by:

getAssociation in interface GridDialect

createAssociation

public Association createAssociation(AssociationKey key,
                                     AssociationContext associationContext)

Specified by:

createAssociation in interface GridDialect

insertOrUpdateAssociation

public void insertOrUpdateAssociation(AssociationKey key,
                                      Association association,
                                      AssociationContext associationContext)

Specified by:

insertOrUpdateAssociation in interface GridDialect

removeAssociation

public void removeAssociation(AssociationKey key,
                              AssociationContext associationContext)

Specified by:

removeAssociation in interface GridDialect

nextValue

public Number nextValue(NextValueRequest request)

Specified by:

nextValue in interface GridDialect

isStoredInEntityStructure

public boolean isStoredInEntityStructure(AssociationKeyMetadata associationKeyMetadata,
                                         AssociationTypeContext associationTypeContext)

Specified by:

isStoredInEntityStructure in interface GridDialect

overrideType

public GridType overrideType(org.hibernate.type.Type type)

Specified by:

overrideType in interface GridDialect

Overrides:

overrideType in class BaseGridDialect

forEachTuple

public void forEachTuple(ModelConsumer consumer,
                         TupleContext tupleContext,
                         EntityKeyMetadata entityKeyMetadata)

Specified by:

forEachTuple in interface GridDialect

executeBackendQuery

public ClosableIterator<Tuple> executeBackendQuery(BackendQuery<MongoDBQueryDescriptor> backendQuery,
                                                   QueryParameters queryParameters)

Specified by:

executeBackendQuery in interface QueryableGridDialect<MongoDBQueryDescriptor>

executeBackendUpdateQuery

public int executeBackendUpdateQuery(BackendQuery<MongoDBQueryDescriptor> backendQuery,
                                     QueryParameters queryParameters)

Specified by:

executeBackendUpdateQuery in interface QueryableGridDialect<MongoDBQueryDescriptor>

parseNativeQuery

public MongoDBQueryDescriptor parseNativeQuery(String nativeQuery)

Specified by:

parseNativeQuery in interface QueryableGridDialect<MongoDBQueryDescriptor>

getDuplicateInsertPreventionStrategy

public DuplicateInsertPreventionStrategy getDuplicateInsertPreventionStrategy(EntityKeyMetadata entityKeyMetadata)

Specified by:

getDuplicateInsertPreventionStrategy in interface GridDialect

Overrides:

getDuplicateInsertPreventionStrategy in class BaseGridDialect

executeBatch

public void executeBatch(OperationsQueue queue)

Specified by:

executeBatch in interface BatchableGridDialect

getParameterMetadataBuilder

public ParameterMetadataBuilder getParameterMetadataBuilder()

Specified by:

getParameterMetadataBuilder in interface QueryableGridDialect<MongoDBQueryDescriptor>