org.hibernate.ogm.datastore.redis

Class RedisJsonDialect

java.lang.Object

org.hibernate.ogm.dialect.spi.BaseGridDialect

org.hibernate.ogm.dialect.impl.AbstractGroupingByEntityDialect

org.hibernate.ogm.datastore.redis.AbstractRedisDialect

org.hibernate.ogm.datastore.redis.RedisJsonDialect

All Implemented Interfaces:

Serializable, org.hibernate.ogm.dialect.batch.spi.GroupingByEntityDialect, org.hibernate.ogm.dialect.multiget.spi.MultigetGridDialect, org.hibernate.ogm.dialect.spi.GridDialect, org.hibernate.service.Service

public class RedisJsonDialect
extends AbstractRedisDialect
implements org.hibernate.ogm.dialect.multiget.spi.MultigetGridDialect, org.hibernate.ogm.dialect.batch.spi.GroupingByEntityDialect

Stores tuples and associations inside Redis as JSON.

Tuples are stored in Redis as a JSON serialization of a Entity object. Associations are stored in Redis obtained as a JSON serialization of a Association object either within the entity or external. See DocumentStoreProperties.ASSOCIATIONS_STORE on how to configure entity or external storage.

Author:

Mark Paluch, Guillaume Smet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonEntityStorageStrategy	entityStorageStrategy

Fields inherited from class org.hibernate.ogm.datastore.redis.AbstractRedisDialect

ASSOCIATIONS, clusterMode, connection, IDENTIFIERS, strategy

Constructor Summary

Constructors

Constructor and Description
RedisJsonDialect(RedisDatastoreProvider provider)

Method Summary

Modifier and Type	Method and Description
org.hibernate.ogm.model.spi.Association	createAssociation(org.hibernate.ogm.model.key.spi.AssociationKey key, org.hibernate.ogm.dialect.spi.AssociationContext associationContext)
org.hibernate.ogm.model.spi.Tuple	createTuple(org.hibernate.ogm.model.key.spi.EntityKey key, org.hibernate.ogm.dialect.spi.OperationContext operationContext)
void	executeGroupedChangesToEntity(org.hibernate.ogm.dialect.batch.spi.GroupedChangesToEntityOperation groupedOperation)
void	forEachTuple(org.hibernate.ogm.dialect.spi.ModelConsumer consumer, org.hibernate.ogm.dialect.spi.TupleTypeContext tupleTypeContext, org.hibernate.ogm.model.key.spi.EntityKeyMetadata entityKeyMetadata)
org.hibernate.ogm.model.spi.Association	getAssociation(org.hibernate.ogm.model.key.spi.AssociationKey key, org.hibernate.ogm.dialect.spi.AssociationContext associationContext)
protected Object	getAssociationRows(org.hibernate.ogm.model.spi.Association association, org.hibernate.ogm.model.key.spi.AssociationKey key, org.hibernate.ogm.dialect.spi.AssociationContext associationContext) Returns the rows of the given association as to be stored in the database.
JsonEntityStorageStrategy	getEntityStorageStrategy()
org.hibernate.ogm.model.spi.Tuple	getTuple(org.hibernate.ogm.model.key.spi.EntityKey key, org.hibernate.ogm.dialect.spi.OperationContext operationContext)
List<org.hibernate.ogm.model.spi.Tuple>	getTuples(org.hibernate.ogm.model.key.spi.EntityKey[] keys, org.hibernate.ogm.dialect.spi.TupleContext tupleContext)
boolean	isStoredInEntityStructure(org.hibernate.ogm.model.key.spi.AssociationKeyMetadata keyMetadata, org.hibernate.ogm.dialect.spi.AssociationTypeContext associationTypeContext)
org.hibernate.ogm.type.spi.GridType	overrideType(org.hibernate.type.Type type)

Methods inherited from class org.hibernate.ogm.datastore.redis.AbstractRedisDialect

addIdToEntity, addKeyValuesFromKeyName, associationId, entityId, getAssociation, getAssociationRow, getEmbeddingEntityTuplePointer, getKeyWithoutTablePrefix, getObjectTTL, identifierId, isClusterMode, keyStringToMap, keyToMap, nextValue, remove, removeAssociations, removeTuple, scan, setObjectTTL, storeAssociation, supportsSequences

Methods inherited from class org.hibernate.ogm.dialect.impl.AbstractGroupingByEntityDialect

executeBatch, flushPendingOperations, insertOrUpdateAssociation, insertOrUpdateTuple, removeAssociation

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

getDuplicateInsertPreventionStrategy, getLockingStrategy, isInTheInsertionQueue, usesNavigationalInformationForInverseSideOfAssociations

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.batch.spi.GroupingByEntityDialect

executeBatch, flushPendingOperations

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

getDuplicateInsertPreventionStrategy, getLockingStrategy, insertOrUpdateAssociation, insertOrUpdateTuple, nextValue, removeAssociation, removeTuple, supportsSequences, usesNavigationalInformationForInverseSideOfAssociations

Field Detail

entityStorageStrategy

protected final JsonEntityStorageStrategy entityStorageStrategy

Constructor Detail

RedisJsonDialect

public RedisJsonDialect(RedisDatastoreProvider provider)

Method Detail

overrideType

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

Specified by:

overrideType in interface org.hibernate.ogm.dialect.spi.GridDialect

Overrides:

overrideType in class org.hibernate.ogm.dialect.spi.BaseGridDialect

getTuple

public org.hibernate.ogm.model.spi.Tuple getTuple(org.hibernate.ogm.model.key.spi.EntityKey key,
                                                  org.hibernate.ogm.dialect.spi.OperationContext operationContext)

Specified by:

getTuple in interface org.hibernate.ogm.dialect.spi.GridDialect

createTuple

public org.hibernate.ogm.model.spi.Tuple createTuple(org.hibernate.ogm.model.key.spi.EntityKey key,
                                                     org.hibernate.ogm.dialect.spi.OperationContext operationContext)

Specified by:

createTuple in interface org.hibernate.ogm.dialect.spi.GridDialect

executeGroupedChangesToEntity

public void executeGroupedChangesToEntity(org.hibernate.ogm.dialect.batch.spi.GroupedChangesToEntityOperation groupedOperation)

Specified by:

executeGroupedChangesToEntity in class org.hibernate.ogm.dialect.impl.AbstractGroupingByEntityDialect

isStoredInEntityStructure

public boolean isStoredInEntityStructure(org.hibernate.ogm.model.key.spi.AssociationKeyMetadata keyMetadata,
                                         org.hibernate.ogm.dialect.spi.AssociationTypeContext associationTypeContext)

Specified by:

isStoredInEntityStructure in interface org.hibernate.ogm.dialect.spi.GridDialect

getAssociation

public org.hibernate.ogm.model.spi.Association getAssociation(org.hibernate.ogm.model.key.spi.AssociationKey key,
                                                              org.hibernate.ogm.dialect.spi.AssociationContext associationContext)

Specified by:

getAssociation in interface org.hibernate.ogm.dialect.spi.GridDialect

createAssociation

public org.hibernate.ogm.model.spi.Association createAssociation(org.hibernate.ogm.model.key.spi.AssociationKey key,
                                                                 org.hibernate.ogm.dialect.spi.AssociationContext associationContext)

Specified by:

createAssociation in interface org.hibernate.ogm.dialect.spi.GridDialect

getAssociationRows

protected Object getAssociationRows(org.hibernate.ogm.model.spi.Association association,
                                    org.hibernate.ogm.model.key.spi.AssociationKey key,
                                    org.hibernate.ogm.dialect.spi.AssociationContext associationContext)

Returns the rows of the given association as to be stored in the database. Elements of the returned list are either

• plain values such as Strings, ints etc. in case there is exactly one row key column which is not part of the association key (in this case we don't need to persist the key name as it can be restored from the association key upon loading) or
• Entitys with keys/values for all row key columns which are not part of the association key

forEachTuple

public void forEachTuple(org.hibernate.ogm.dialect.spi.ModelConsumer consumer,
                         org.hibernate.ogm.dialect.spi.TupleTypeContext tupleTypeContext,
                         org.hibernate.ogm.model.key.spi.EntityKeyMetadata entityKeyMetadata)

Specified by:

forEachTuple in interface org.hibernate.ogm.dialect.spi.GridDialect

getEntityStorageStrategy

public JsonEntityStorageStrategy getEntityStorageStrategy()

getTuples

public List<org.hibernate.ogm.model.spi.Tuple> getTuples(org.hibernate.ogm.model.key.spi.EntityKey[] keys,
                                                         org.hibernate.ogm.dialect.spi.TupleContext tupleContext)

Specified by:

getTuples in interface org.hibernate.ogm.dialect.multiget.spi.MultigetGridDialect