org.hibernate.ogm.datastore.redis

Class AbstractRedisDialect

java.lang.Object

org.hibernate.ogm.dialect.spi.BaseGridDialect

org.hibernate.ogm.datastore.redis.AbstractRedisDialect

All Implemented Interfaces:

Serializable, GridDialect, org.hibernate.service.Service

Direct Known Subclasses:

RedisHashDialect, RedisJsonDialect

public abstract class AbstractRedisDialect
extends BaseGridDialect

Author:

Mark Paluch

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSOCIATIONS
protected boolean	clusterMode
protected com.lambdaworks.redis.cluster.api.sync.RedisClusterCommands<String,String>	connection
static String	IDENTIFIERS
protected JsonSerializationStrategy	strategy

Constructor Summary

Constructors

Constructor and Description
AbstractRedisDialect(com.lambdaworks.redis.cluster.api.sync.RedisClusterCommands<String,String> connection, boolean configuredForCluster) Creates a new AbstractRedisDialect.

Method Summary

Modifier and Type	Method and Description
protected void	addIdToEntity(Entity entity, String[] columnNames, Object[] columnValues)
protected void	addKeyValuesFromKeyName(EntityKeyMetadata entityKeyMetadata, String prefix, String key, Entity document)
protected String	associationId(AssociationKey key) Create a String representation of the entity key in the format of Association:(table name):(columnId).
Tuple	createTuple(EntityKey key, TupleContext tupleContext)
String	entityId(EntityKey key) Create a String representation of the key in the format of (table name):(columnId).
protected void	expireAssociation(AssociationKey key, Long ttl)
protected void	expireEntity(EntityKey key, Long ttl)
protected Association	getAssociation(AssociationKey key) Retrieve association from a Redis List or Redis Set, depending on the association type.
protected static Object	getAssociationRow(Tuple row, AssociationKey associationKey)
protected String	getKeyWithoutTablePrefix(String prefixBytes, String key)
protected Long	getTTL(AssociationContext associationContext)
protected Long	getTTL(OptionsContext optionsContext)
protected String	identifierId(IdSourceKey key) Create a String representation of the identifier key in the format of Identifiers:(table name):(columnId).
boolean	isClusterMode()
protected Map<String,Object>	keyStringToMap(EntityKeyMetadata entityKeyMetadata, String key) Deconstruct the key name into its components: Single key: Use the value from the key Multiple keys: De-serialize the JSON map.
protected Map<String,Object>	keyToMap(EntityKeyMetadata entityKeyMetadata, String key) Deconstruct the key name into its components: Single key: Use the value from the key Multiple keys: De-serialize the JSON map.
Number	nextValue(NextValueRequest request)
protected void	remove(EntityKey key)
protected void	removeAssociation(AssociationKey key)
void	removeTuple(EntityKey key, TupleContext tupleContext)
protected com.lambdaworks.redis.KeyScanCursor<String>	scan(com.lambdaworks.redis.KeyScanCursor<String> cursor, com.lambdaworks.redis.ScanArgs scanArgs) Scan over keys.
protected void	setAssociationTTL(AssociationKey associationKey, AssociationContext associationContext, Long currentTtl)
protected void	setEntityTTL(EntityKey key, Long currentTtl, Long configuredTTL)
protected void	storeAssociation(AssociationKey key, Association association) Store an association to a Redis List or Redis Set, depending on the association type.
boolean	supportsSequences()

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

getDuplicateInsertPreventionStrategy, getLockingStrategy, overrideType

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

createAssociation, forEachTuple, getAssociation, getTuple, insertOrUpdateAssociation, insertOrUpdateTuple, isStoredInEntityStructure, removeAssociation

Field Detail

IDENTIFIERS

public static final String IDENTIFIERS

See Also:

Constant Field Values

ASSOCIATIONS

public static final String ASSOCIATIONS

See Also:

Constant Field Values

connection

protected final com.lambdaworks.redis.cluster.api.sync.RedisClusterCommands<String,String> connection

strategy

protected final JsonSerializationStrategy strategy

clusterMode

protected final boolean clusterMode

Constructor Detail

AbstractRedisDialect

public AbstractRedisDialect(com.lambdaworks.redis.cluster.api.sync.RedisClusterCommands<String,String> connection,
                            boolean configuredForCluster)

Creates a new AbstractRedisDialect.

Parameters:

connection - a Redis connection (A regular Redis connection implements also RedisClusterCommands)

configuredForCluster - true if the connection is configured for cluster operations.

Method Detail

createTuple

public Tuple createTuple(EntityKey key,
                         TupleContext tupleContext)

nextValue

public Number nextValue(NextValueRequest request)

supportsSequences

public boolean supportsSequences()

Specified by:

supportsSequences in interface GridDialect

Overrides:

supportsSequences in class BaseGridDialect

identifierId

protected String identifierId(IdSourceKey key)

Create a String representation of the identifier key in the format of Identifiers:(table name):(columnId). IDENTIFIERS

Parameters:

key - Key for the identifier

Returns:

byte array containing the key

removeTuple

public void removeTuple(EntityKey key,
                        TupleContext tupleContext)

addKeyValuesFromKeyName

protected void addKeyValuesFromKeyName(EntityKeyMetadata entityKeyMetadata,
                                       String prefix,
                                       String key,
                                       Entity document)

getAssociationRow

protected static Object getAssociationRow(Tuple row,
                                          AssociationKey associationKey)

getTTL

protected Long getTTL(OptionsContext optionsContext)

getTTL

protected Long getTTL(AssociationContext associationContext)

getKeyWithoutTablePrefix

protected String getKeyWithoutTablePrefix(String prefixBytes,
                                          String key)

setAssociationTTL

protected void setAssociationTTL(AssociationKey associationKey,
                                 AssociationContext associationContext,
                                 Long currentTtl)

setEntityTTL

protected void setEntityTTL(EntityKey key,
                            Long currentTtl,
                            Long configuredTTL)

expireEntity

protected void expireEntity(EntityKey key,
                            Long ttl)

expireAssociation

protected void expireAssociation(AssociationKey key,
                                 Long ttl)

removeAssociation

protected void removeAssociation(AssociationKey key)

remove

protected void remove(EntityKey key)

keyStringToMap

protected Map<String,Object> keyStringToMap(EntityKeyMetadata entityKeyMetadata,
                                            String key)

Deconstruct the key name into its components: Single key: Use the value from the key Multiple keys: De-serialize the JSON map.

addIdToEntity

protected void addIdToEntity(Entity entity,
                             String[] columnNames,
                             Object[] columnValues)

associationId

protected String associationId(AssociationKey key)

Create a String representation of the entity key in the format of Association:(table name):(columnId). ASSOCIATIONS

Parameters:

key - Key of the association

Returns:

byte array containing the key

entityId

public String entityId(EntityKey key)

Create a String representation of the key in the format of (table name):(columnId).

Parameters:

key - Key of the entity

Returns:

byte array containing the key

keyToMap

protected Map<String,Object> keyToMap(EntityKeyMetadata entityKeyMetadata,
                                      String key)

Deconstruct the key name into its components: Single key: Use the value from the key Multiple keys: De-serialize the JSON map.

getAssociation

protected Association getAssociation(AssociationKey key)

Retrieve association from a Redis List or Redis Set, depending on the association type.

Parameters:

key - the association key

Returns:

the association

storeAssociation

protected void storeAssociation(AssociationKey key,
                                Association association)

Store an association to a Redis List or Redis Set, depending on the association type.

Parameters:

key - the association key

association - the association document

scan

protected com.lambdaworks.redis.KeyScanCursor<String> scan(com.lambdaworks.redis.KeyScanCursor<String> cursor,
                                                           com.lambdaworks.redis.ScanArgs scanArgs)

Scan over keys. This method is aware whether the client is connected to a Redis Cluster. If so, then a Redis Cluster scan requires to iterate over master nodes and keep the state within a custom KeyScanCursor instance.

Parameters:

cursor -

scanArgs -

Returns:

isClusterMode

public boolean isClusterMode()

Returns:

true if the connected Redis node (default connection) is running in Redis Cluster mode.