org.openingo.spring.boot.extension.data.redis

Class RedisTemplateX<K,V>

java.lang.Object

org.openingo.spring.boot.extension.data.redis.RedisTemplateX<K,V>

All Implemented Interfaces:

IGeoCommands<K,V>, IHashCommands<K,V>, IHyperLogLogCommands<K,V>, IListCommands<K,V>, IRedisCommands<K,V>, IRedisTransactionsCommands<K,V>, ISetCommands<K,V>, IValueCommands<K,V>, IZSetCommands<K,V>

Direct Known Subclasses:

RedisIdEngine, RedisStringKeyTemplateX

public class RedisTemplateX<K,V>
extends Object
implements IRedisCommands<K,V>

RedisTemplateX

Author:

Qicz

Constructor Summary

Constructors

Constructor and Description
RedisTemplateX(org.springframework.data.redis.core.RedisTemplate<K,V> redisTemplate)

Method Summary

Modifier and Type	Method and Description
Integer	append(K key, String value) Append a value to key.
List<Long>	bitField(K key, org.springframework.data.redis.connection.BitFieldSubCommands subCommands) Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.
V	blPop(K key, long timeoutSeconds) Removes and returns first element from lists stored at key .
org.springframework.data.redis.core.BoundGeoOperations<K,V>	boundGeoOps(K key)
<HK,HV> org.springframework.data.redis.core.BoundHashOperations<K,HK,HV>	boundHashOps(K key)
org.springframework.data.redis.core.BoundListOperations<K,V>	boundListOps(K key)
org.springframework.data.redis.core.BoundSetOperations<K,V>	boundSetOps(K key)
org.springframework.data.redis.core.BoundValueOperations<K,V>	boundValueOps(K key)
org.springframework.data.redis.core.BoundZSetOperations<K,V>	boundZSetOps(K key)
V	brPop(K key, long timeoutSeconds) Removes and returns last element from lists stored at key.
V	brPoplPush(K srcKey, K dstKey, long timeoutSeconds) Remove the last element from list at srcKey, append it to dstKey and return its value. Blocks connection until element available or timeoutSeconds reached.
Long	countExistingKeys(Collection<K> keys) Count the number of keys that exist.
Long	decr(K key) Decrement an integer value stored as string value under key by one.
Long	decrBy(K key, long delta) Decrement an integer value stored as string value under key by delta.
Long	del(Collection<K> keys) Delete given keys.
Boolean	del(K key) Delete given key.
void	discard() Discard all commands issued after multi().
List<Object>	exec() Executes all queued commands in a transaction started with multi().
List<Object>	exec(org.springframework.data.redis.serializer.RedisSerializer<?> valueSerializer) Execute a transaction, using the provided RedisSerializer to deserialize any results that are byte[]s or Collections of byte[]s.
<T> T	execute(SessionCallbackX session) Executes a Redis session.
List<Object>	executePipelined(SessionCallbackX session) Executes the given Redis session on a pipelined connection.
List<Object>	executePipelined(SessionCallbackX session, org.springframework.data.redis.serializer.RedisSerializer<?> resultSerializer) Executes the given Redis session on a pipelined connection, returning the results using a dedicated serializer.
Boolean	exists(K key) Determine if given key exists.
Boolean	expire(K key, long timeoutSeconds) Set time(Seconds) to live for given key..
Boolean	expireAt(K key, Date date) Set the expiration for given key as a date timestamp.
Long	geoAdd(K key, Iterable<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>> geoLocations) Add RedisGeoCommands.GeoLocations to key
Long	geoAdd(K key, Map<V,org.springframework.data.geo.Point> memberCoordinateMap) Add Map of member / Point pairs to key.
Long	geoAdd(K key, org.springframework.data.geo.Point point, V member) Add Point with given member name to key.
Long	geoAdd(K key, org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V> location) Add RedisGeoCommands.GeoLocation to key.
org.springframework.data.geo.Distance	geoDist(K key, V member1, V member2) Get the Distance between member1 and member2.
org.springframework.data.geo.Distance	geoDist(K key, V member1, V member2, org.springframework.data.geo.Metric metric) Get the Distance between member1 and member2 in the given Metric.
List<String>	geoHash(K key, V... members) Get Geohash representation of the position for one or more members.
List<org.springframework.data.geo.Point>	geoPos(K key, V... members) Get the Point representation of positions for one or more members.
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>>	geoRadius(K key, org.springframework.data.geo.Circle within) Get the members within the boundaries of a given Circle.
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>>	geoRadius(K key, org.springframework.data.geo.Circle within, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args) Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>>	geoRadiusByMember(K key, V member, org.springframework.data.geo.Distance distance) Get the members within the circle defined by the members coordinates and given radius applying Metric.
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>>	geoRadiusByMember(K key, V member, org.springframework.data.geo.Distance distance, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args) Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>>	geoRadiusByMember(K key, V member, double radius) Get the members within the circle defined by the members coordinates and given radius.
Long	geoRemove(K key, V... members) Remove the members.
V	get(K key) Get the value of key.
Boolean	getBit(K key, long offset) Get the bit value at offset of value at key.
String	getRange(K key, long start, long end) Get a substring of value of key between begin and end.
org.springframework.data.redis.core.RedisTemplate<K,V>	getRedisTemplate()
V	getSet(K key, V value) Set value of key and return its old value.
Long	hDel(K key, Object... hashKeys) Delete given hash hashKeys.
Boolean	hExists(K key, Object hashKey) Determine if given hash hashKey exists.
<T> T	hGet(K key, Object hashKey) Get value for given hashKey from hash at key.
<HK,HV> Map<HK,HV>	hGetAll(K key) Get entire hash stored at key.
<HK> Set<HK>	hKeys(K key) Get key set (fields) of hash at key.
Long	hLen(K key) Get size of hash at key.
<T> List<T>	hMget(K key, Collection<Object> hashKeys) Get values for given hashKeys from hash at key.
void	hmset(K key, Map<Object,Object> m) Set multiple hash fields to multiple values using data provided in m.
void	hSet(K key, Object hashKey, Object value) Set the value of a hash hashKey.
<HV> List<HV>	hVals(K key) Get entry set (values) of hash at key.
Long	incr(K key) Increment an integer value stored as string value under key by one.
Long	incrBy(K key, long delta) Increment an integer value stored as string value under key by delta.
V	lIndex(K key, long index) Get element at index form list at key.
Long	lLen(K key) Get the size of list stored at key.
V	lPop(K key) Removes and returns first element in list stored at key.
Long	lPush(K key, Collection<V> values) Prepend values to key.
Long	lPush(K key, V... values) Prepend values to key.
Long	lPush(K key, V value) Prepend value to key.
Long	lPushx(K key, V value) Prepend values to key only if the list exists.
List<V>	lRange(K key, long start, long end) Get elements between begin and end from list at key.
Long	lRem(K key, long count, V value) Removes the first count occurrences of value from the list stored at key.
void	lSet(K key, long index, V value) Set the value list element at index.
void	ltrim(K key, long start, long end) Trim list at key to elements between start and end.
List<V>	mGet(Collection<K> keys) Get multiple keys.
Boolean	move(K key, int dbIndex) Move given key to database with index.
void	mSet(Map<K,V> map) Set multiple keys to multiple values using key-value pairs provided in tuple.
void	mSet(Object... keysValues) Set multiple keys to multiple values using key-value pairs.
void	multi() Mark the start of a transaction block.
org.springframework.data.redis.core.ClusterOperations<K,V>	opsForCluster()
org.springframework.data.redis.core.GeoOperations<K,V>	opsForGeo()
<HK,HV> org.springframework.data.redis.core.HashOperations<K,HK,HV>	opsForHash()
org.springframework.data.redis.core.HyperLogLogOperations<K,V>	opsForHyperLogLog()
org.springframework.data.redis.core.ListOperations<K,V>	opsForList()
org.springframework.data.redis.core.SetOperations<K,V>	opsForSet()
org.springframework.data.redis.core.ValueOperations<K,V>	opsForValue()
org.springframework.data.redis.core.ZSetOperations<K,V>	opsForZSet()
Boolean	persist(K key) Remove the expiration from given key.
Boolean	pExpire(K key, long millTimeoutSeconds) Set time(Seconds) to live for given key..
Long	pfAdd(K key, V... values) Adds the given values to the key.
Long	pfCount(K... keys) Gets the current number of elements within the key.
Long	pfMerge(K destination, K... sourceKeys) Merges all values of given sourceKeys into destination key.
void	rename(K oldKey, K newKey) Rename key oldKey to newKey.
V	rPop(K key) Removes and returns last element in list stored at key.
V	rPoplPush(K srcKey, K dstKey) Remove the last element from list at sourceKey, append it to destinationKey and return its value.
Long	rPush(K key, Collection<V> values) Append values to key.
Long	rPush(K key, V... values) Append values to key.
Long	rPush(K key, V value) Append value to key.
Long	rPushx(K key, V value) Append values to key only if the list exists.
Long	sAdd(K key, V... values) Add given values to set at key.
Long	sCard(K key) Get size of set at key.
Set<V>	sDiff(K key, Collection<K> otherKeys) Diff all sets for given key and otherKeys.
Set<V>	sDiff(K key, K otherKey) Diff all sets for given key and otherKey.
Long	sDiffStore(K key, Collection<K> otherKeys, K destKey) Diff all sets for given key and otherKeys and store result in destKey.
Long	sDiffStore(K key, K otherKey, K destKey) Diff all sets for given key and otherKey and store result in destKey.
void	set(K key, V value) Set value for key.
Boolean	setBit(K key, long offset, boolean value) Sets the bit at offset in value stored at key.
void	setEnableTransactionSupport(Boolean enableTransactionSupport)
void	setEx(K key, long timeoutSeconds, V value) Set the value and expiration timeout for key.
void	setEx(K key, long timeout, V value, TimeUnit unit) Set the value and expiration timeout for key.
Boolean	setNx(K key, V value) Set key to hold the string value if key is absent.
Boolean	setNx(K key, V value, long timeoutSeconds) Set key to hold the string value and expiration timeout if key is absent.
Boolean	setNx(K key, V value, long timeout, TimeUnit unit) Set key to hold the string value and expiration timeout if key is absent.
void	setRange(K key, V value, long offset) Overwrite parts of key starting at the specified offset with given value.
Boolean	setXx(K key, V value) Set key to hold the string value if key is present.
Boolean	setXx(K key, V value, long timeoutSeconds) Set key to hold the string value and expiration timeout if key is present.
Boolean	setXx(K key, V value, long timeout, TimeUnit unit) Set key to hold the string value and expiration timeout if key is present.
Set<V>	sInter(K key, Collection<K> otherKeys) Returns the members intersecting all given sets at key and otherKeys.
Set<V>	sInter(K key, K otherKey) Returns the members intersecting all given sets at key and otherKey.
Long	sInterStore(K key, Collection<K> otherKeys, K destKey) Intersect all given sets at key and otherKeys and store result in destKey.
Long	sInterstore(K key, K otherKey, K destKey) Intersect all given sets at key and otherKey and store result in destKey.
Boolean	sIsMember(K key, Object member) Check if set at key contains value.
Set<V>	sMembers(K key) Get all elements of set at key.
List<V>	sort(org.springframework.data.redis.core.query.SortQuery<K> query) Sort the elements for query.
<T,S> List<T>	sort(org.springframework.data.redis.core.query.SortQuery<K> query, org.springframework.data.redis.core.BulkMapper<T,S> bulkMapper, org.springframework.data.redis.serializer.RedisSerializer<S> resultSerializer) Sort the elements for query applying BulkMapper and RedisSerializer.
<T> List<T>	sort(org.springframework.data.redis.core.query.SortQuery<K> query, org.springframework.data.redis.core.BulkMapper<T,V> bulkMapper) Sort the elements for query applying BulkMapper.
Long	sort(org.springframework.data.redis.core.query.SortQuery<K> query, K storeKey) Sort the elements for query and store result in storeKey.
<T> List<T>	sort(org.springframework.data.redis.core.query.SortQuery<K> query, org.springframework.data.redis.serializer.RedisSerializer<T> resultSerializer) Sort the elements for query applying RedisSerializer.
V	sPop(K key) Remove and return a random member from set at key.
V	sRandMember(K key) Get random element from set at key.
List<V>	sRandMember(K key, long count) Get count random elements from set at key.
Long	sRem(K key, Object... members) Remove given values from set at key and return the number of removed elements.
Long	strLen(K key) Get the length of the value stored at key.
Set<V>	sUnion(K key, Collection<K> otherKeys) Union all sets at given keys and otherKeys.
Set<V>	sUnion(K key, K otherKey) Union all sets at given keys and otherKey.
Long	sUnionStore(K key, Collection<K> otherKeys, K destKey) Union all sets at given key and otherKeys and store result in destKey.
Long	sUnionStore(K key, K otherKey, K destKey) Union all sets at given key and otherKey and store result in destKey.
Long	ttl(K key) Get the time to live for key in seconds.
org.springframework.data.redis.connection.DataType	type(K key) Determine the type stored at key.
Long	unlink(Collection<K> keys) Unlink the keys from the keyspace.
Boolean	unlink(K key) Unlink the key from the keyspace.
void	unwatch() Flushes all the previously watch(Object) keys.
void	watch(Collection<K> keys) Watch given keys for modifications during transaction started with multi().
void	watch(K key) Watch given key for modifications during transaction started with multi().
Long	zAdd(K key, Map<V,Double> scoreMembers) Add scoreMembers to a sorted set at key, or update its score if it already exists.
Boolean	zAdd(K key, V member, double score) Add member to a sorted set at key, or update its score if it already exists.
Long	zCard(K key) Returns the number of elements of the sorted set stored with given key.
Long	zCount(K key, double min, double max) Count number of elements within sorted set with scores between min and max.
Double	zIncrby(K key, V member, double score) Increment the score of element with member in sorted set by score.
Long	zInterStore(K key, Collection<K> otherKeys, K destKey) Intersect sorted sets at key and otherKeys and store result in destination destKey.
Long	zInterStore(K key, Collection<K> otherKeys, K destKey, org.springframework.data.redis.connection.RedisZSetCommands.Aggregate aggregate, org.springframework.data.redis.connection.RedisZSetCommands.Weights weights) Intersect sorted sets at key and otherKeys and store result in destination destKey.
Long	zInterStore(K key, K otherKey, K destKey) Intersect sorted sets at key and otherKey and store result in destination destKey.
Set<V>	zRange(K key, long start, long end) Get elements between start and end from sorted set.
Set<V>	zRangeByLex(K key, org.springframework.data.redis.connection.RedisZSetCommands.Range range) Get all elements with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range#getMin() and RedisZSetCommands.Range#getMax().
Set<V>	zRangeByLex(K key, org.springframework.data.redis.connection.RedisZSetCommands.Range range, org.springframework.data.redis.connection.RedisZSetCommands.Limit limit) Get all elements n elements, where n = RedisZSetCommands.Limit#getCount(), starting at RedisZSetCommands.Limit#getOffset() with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range#getMin() and RedisZSetCommands.Range#getMax().
Set<V>	zRangeByScore(K key, double min, double max) Get elements where score is between min and max from sorted set.
Set<V>	zRangeByScore(K key, double min, double max, long offset, long count) Get elements in range from min to max where score is between min and max from sorted set.
Long	zRank(K key, Object member) Determine the index of element with value in a sorted set.
Long	zRem(K key, Object... members) Remove values from sorted set.
Long	zRemRangeByRank(K key, long start, long end) Remove elements in range between start and end from sorted set with key.
Long	zRemRangeByScore(K key, double min, double max) Remove elements with scores between min and max from sorted set with key.
Set<V>	zRevRange(K key, double min, double max) Get elements where score is between min and max from sorted set ordered from high to low.
Set<V>	zRevRange(K key, long start, long end) Get elements in range from start to end from sorted set ordered from high to low.
Set<V>	zRevRangeByScore(K key, double min, double max, long offset, long count) Get elements in range from start to end where score is between min and max from sorted set ordered high -> low.
Long	zRevRank(K key, Object member) Determine the index of element with member in a sorted set when scored high to low.
org.springframework.data.redis.core.Cursor<org.springframework.data.redis.core.ZSetOperations.TypedTuple<V>>	zScan(K key, org.springframework.data.redis.core.ScanOptions options) Iterate over elements in zset at key.
Double	zScore(K key, Object member) Get the score of element with member from sorted set with key key.
Long	zUnionStore(K key, Collection<K> otherKeys, K destKey) Union sorted sets at key and otherKeys and store result in destination destKey.
Long	zUnionStore(K key, Collection<K> otherKeys, K destKey, org.springframework.data.redis.connection.RedisZSetCommands.Aggregate aggregate, org.springframework.data.redis.connection.RedisZSetCommands.Weights weights) Union sorted sets at key and otherKeys and store result in destination destKey.
Long	zUnionStore(K key, K otherKey, K destKey) Union sorted sets at key and otherKeys and store result in destination destKey.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openingo.spring.boot.extension.data.redis.commands.IZSetCommands

zInterStore, zUnionStore

Constructor Detail

RedisTemplateX

public RedisTemplateX(org.springframework.data.redis.core.RedisTemplate<K,V> redisTemplate)

Method Detail

opsForCluster

public org.springframework.data.redis.core.ClusterOperations<K,V> opsForCluster()

opsForGeo

public org.springframework.data.redis.core.GeoOperations<K,V> opsForGeo()

boundGeoOps

public org.springframework.data.redis.core.BoundGeoOperations<K,V> boundGeoOps(K key)

boundHashOps

public <HK,HV> org.springframework.data.redis.core.BoundHashOperations<K,HK,HV> boundHashOps(K key)

opsForHash

public <HK,HV> org.springframework.data.redis.core.HashOperations<K,HK,HV> opsForHash()

opsForHyperLogLog

public org.springframework.data.redis.core.HyperLogLogOperations<K,V> opsForHyperLogLog()

opsForList

public org.springframework.data.redis.core.ListOperations<K,V> opsForList()

boundListOps

public org.springframework.data.redis.core.BoundListOperations<K,V> boundListOps(K key)

boundSetOps

public org.springframework.data.redis.core.BoundSetOperations<K,V> boundSetOps(K key)

opsForSet

public org.springframework.data.redis.core.SetOperations<K,V> opsForSet()

boundValueOps

public org.springframework.data.redis.core.BoundValueOperations<K,V> boundValueOps(K key)

opsForValue

public org.springframework.data.redis.core.ValueOperations<K,V> opsForValue()

boundZSetOps

public org.springframework.data.redis.core.BoundZSetOperations<K,V> boundZSetOps(K key)

opsForZSet

public org.springframework.data.redis.core.ZSetOperations<K,V> opsForZSet()

getRedisTemplate

public org.springframework.data.redis.core.RedisTemplate<K,V> getRedisTemplate()

setEnableTransactionSupport

public void setEnableTransactionSupport(Boolean enableTransactionSupport)

set

public void set(K key,
                V value)

Set value for key.

Specified by:

set in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

See Also:

Redis Documentation: SET

setEx

public void setEx(K key,
                  long timeoutSeconds,
                  V value)

Set the value and expiration timeout for key.

Specified by:

setEx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

timeoutSeconds - the key expiration timeout.

See Also:

Redis Documentation: SETEX

setEx

public void setEx(K key,
                  long timeout,
                  V value,
                  TimeUnit unit)

Set the value and expiration timeout for key.

Specified by:

setEx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

timeout - the key expiration timeout.

value - must not be null.

unit - must not be null.

See Also:

Redis Documentation: SETEX

setNx

public Boolean setNx(K key,
                     V value)

Set key to hold the string value if key is absent.

Specified by:

setNx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SETNX

setNx

public Boolean setNx(K key,
                     V value,
                     long timeoutSeconds)

Set key to hold the string value and expiration timeout if key is absent.

Specified by:

setNx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

timeoutSeconds - the key expiration timeout.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: SET

setNx

public Boolean setNx(K key,
                     V value,
                     long timeout,
                     TimeUnit unit)

Set key to hold the string value and expiration timeout if key is absent.

Specified by:

setNx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

timeout - the key expiration timeout.

unit - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: SET

setXx

public Boolean setXx(K key,
                     V value)

Set key to hold the string value if key is present. redis: SET key value XX

Specified by:

setXx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

Returns:

command result indicating if the key has been set.

Throws:

IllegalArgumentException - if either key or value is not present.

See Also:

Redis Documentation: SET

setXx

public Boolean setXx(K key,
                     V value,
                     long timeoutSeconds)

Set key to hold the string value and expiration timeout if key is present. redis: SET key value EX seconds XX

Specified by:

setXx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

timeoutSeconds - the key expiration timeout.

Returns:

command result indicating if the key has been set.

Throws:

IllegalArgumentException - if either key, value or timeout is not present.

See Also:

Redis Documentation: SET

setXx

public Boolean setXx(K key,
                     V value,
                     long timeout,
                     TimeUnit unit)

Set key to hold the string value and expiration timeout if key is present. redis: SET key value [EX seconds|PX milliseconds] XX

Specified by:

setXx in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value - must not be null.

timeout - the key expiration timeout.

unit - must not be null.

Returns:

command result indicating if the key has been set.

Throws:

IllegalArgumentException - if either key, value or timeout is not present.

See Also:

Redis Documentation: SET

get

public V get(K key)

Get the value of key.

Specified by:

get in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GET

del

public Boolean del(K key)

Delete given key.

Specified by:

del in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

true if the key was removed.

See Also:

Redis Documentation: DEL

del

public Long del(Collection<K> keys)

Delete given keys.

Specified by:

del in interface IValueCommands<K,V>

Parameters:

keys - must not be null.

Returns:

The number of keys that were removed. null when used in pipeline / transaction.

See Also:

Redis Documentation: DEL

mSet

public void mSet(Object... keysValues)

Set multiple keys to multiple values using key-value pairs. "key1", "value1", "key2", "values"

Specified by:

mSet in interface IValueCommands<K,V>

Parameters:

keysValues - must not be null.

See Also:

Redis Documentation: MSET

mSet

public void mSet(Map<K,V> map)

Set multiple keys to multiple values using key-value pairs provided in tuple.

Specified by:

mSet in interface IValueCommands<K,V>

Parameters:

map - must not be null.

See Also:

Redis Documentation: MSET

mGet

public List<V> mGet(Collection<K> keys)

Get multiple keys. Values are returned in the order of the requested keys.

Specified by:

mGet in interface IValueCommands<K,V>

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: MGET

decr

public Long decr(K key)

Decrement an integer value stored as string value under key by one.

Specified by:

decr in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: DECR

decrBy

public Long decrBy(K key,
                   long delta)

Decrement an integer value stored as string value under key by delta.

Specified by:

decrBy in interface IValueCommands<K,V>

Parameters:

key - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: DECRBY

incr

public Long incr(K key)

Increment an integer value stored as string value under key by one.

Specified by:

incr in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: INCR

incrBy

public Long incrBy(K key,
                   long delta)

Increment an integer value stored as string value under key by delta.

Specified by:

incrBy in interface IValueCommands<K,V>

Parameters:

key - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: INCRBY

exists

public Boolean exists(K key)

Determine if given key exists.

Specified by:

exists in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: EXISTS

rename

public void rename(K oldKey,
                   K newKey)

Rename key oldKey to newKey.

Specified by:

rename in interface IValueCommands<K,V>

Parameters:

oldKey - must not be null.

newKey - must not be null.

See Also:

Redis Documentation: RENAME

expire

public Boolean expire(K key,
                      long timeoutSeconds)

Set time(Seconds) to live for given key..

Specified by:

expire in interface IValueCommands<K,V>

Parameters:

key - must not be null.

timeoutSeconds -

Returns:

null when used in pipeline / transaction.

expireAt

public Boolean expireAt(K key,
                        Date date)

Set the expiration for given key as a date timestamp.

Specified by:

expireAt in interface IValueCommands<K,V>

Parameters:

key - must not be null.

date - must not be null.

Returns:

null when used in pipeline / transaction.

pExpire

public Boolean pExpire(K key,
                       long millTimeoutSeconds)

Set time(Seconds) to live for given key..

Specified by:

pExpire in interface IValueCommands<K,V>

Parameters:

key - must not be null.

millTimeoutSeconds -

Returns:

null when used in pipeline / transaction.

getSet

public V getSet(K key,
                V value)

Set value of key and return its old value.

Specified by:

getSet in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GETSET

persist

public Boolean persist(K key)

Remove the expiration from given key.

Specified by:

persist in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: PERSIST

type

public org.springframework.data.redis.connection.DataType type(K key)

Determine the type stored at key.

Specified by:

type in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: TYPE

ttl

public Long ttl(K key)

Get the time to live for key in seconds.

Specified by:

ttl in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: TTL

countExistingKeys

public Long countExistingKeys(Collection<K> keys)

Count the number of keys that exist.

Specified by:

countExistingKeys in interface IValueCommands<K,V>

Parameters:

keys - must not be null.

Returns:

The number of keys existing among the ones specified as arguments. Keys mentioned multiple times and existing are counted multiple times.

See Also:

Redis Documentation: EXISTS

append

public Integer append(K key,
                      String value)

Append a value to key.

Specified by:

append in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: APPEND

getRange

public String getRange(K key,
                       long start,
                       long end)

Get a substring of value of key between begin and end.

Specified by:

getRange in interface IValueCommands<K,V>

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GETRANGE

setRange

public void setRange(K key,
                     V value,
                     long offset)

Overwrite parts of key starting at the specified offset with given value.

Specified by:

setRange in interface IValueCommands<K,V>

Parameters:

key - must not be null.

value -

offset -

See Also:

Redis Documentation: SETRANGE

strLen

public Long strLen(K key)

Get the length of the value stored at key.

Specified by:

strLen in interface IValueCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: STRLEN

setBit

public Boolean setBit(K key,
                      long offset,
                      boolean value)

Sets the bit at offset in value stored at key.

Specified by:

setBit in interface IValueCommands<K,V>

Parameters:

key - must not be null.

offset -

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SETBIT

getBit

public Boolean getBit(K key,
                      long offset)

Get the bit value at offset of value at key.

Specified by:

getBit in interface IValueCommands<K,V>

Parameters:

key - must not be null.

offset -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: GETBIT

bitField

public List<Long> bitField(K key,
                           org.springframework.data.redis.connection.BitFieldSubCommands subCommands)

Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored at a given key.

Specified by:

bitField in interface IValueCommands<K,V>

Parameters:

key - must not be null.

subCommands - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: BITFIELD

hSet

public void hSet(K key,
                 Object hashKey,
                 Object value)

Set the value of a hash hashKey.

Specified by:

hSet in interface IHashCommands<K,V>

Parameters:

key - must not be null.

hashKey - must not be null.

value -

See Also:

Redis Documentation: HSET

hmset

public void hmset(K key,
                  Map<Object,Object> m)

Set multiple hash fields to multiple values using data provided in m.

Specified by:

hmset in interface IHashCommands<K,V>

Parameters:

key - must not be null.

m - must not be null.

See Also:

Redis Documentation: HMSET

hGet

public <T> T hGet(K key,
                  Object hashKey)

Get value for given hashKey from hash at key.

Specified by:

hGet in interface IHashCommands<K,V>

Parameters:

key - must not be null.

hashKey - must not be null.

Returns:

null when key or hashKey does not exist or used in pipeline / transaction.

See Also:

Redis Documentation: HGET

hMget

public <T> List<T> hMget(K key,
                         Collection<Object> hashKeys)

Get values for given hashKeys from hash at key.

Specified by:

hMget in interface IHashCommands<K,V>

Parameters:

key - must not be null.

hashKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HMGET

hDel

public Long hDel(K key,
                 Object... hashKeys)

Delete given hash hashKeys.

Specified by:

hDel in interface IHashCommands<K,V>

Parameters:

key - must not be null.

hashKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HDEL

hExists

public Boolean hExists(K key,
                       Object hashKey)

Determine if given hash hashKey exists.

Specified by:

hExists in interface IHashCommands<K,V>

Parameters:

key - must not be null.

hashKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HEXISTS

hGetAll

public <HK,HV> Map<HK,HV> hGetAll(K key)

Get entire hash stored at key.

Specified by:

hGetAll in interface IHashCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HGETALL

hVals

public <HV> List<HV> hVals(K key)

Get entry set (values) of hash at key.

Specified by:

hVals in interface IHashCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HVALS

hKeys

public <HK> Set<HK> hKeys(K key)

Get key set (fields) of hash at key.

Specified by:

hKeys in interface IHashCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HKEYS

hLen

public Long hLen(K key)

Get size of hash at key.

Specified by:

hLen in interface IHashCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HLEN

lIndex

public V lIndex(K key,
                long index)

Get element at index form list at key.

Specified by:

lIndex in interface IListCommands<K,V>

Parameters:

key - must not be null.

index -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LINDEX

lLen

public Long lLen(K key)

Get the size of list stored at key.

Specified by:

lLen in interface IListCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LLEN

lPop

public V lPop(K key)

Removes and returns first element in list stored at key.

Specified by:

lPop in interface IListCommands<K,V>

Parameters:

key - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: LPOP

lPush

public Long lPush(K key,
                  V value)

Prepend value to key.

Specified by:

lPush in interface IListCommands<K,V>

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSH

lPush

public Long lPush(K key,
                  V... values)

Prepend values to key.

Specified by:

lPush in interface IListCommands<K,V>

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSH

lPush

public Long lPush(K key,
                  Collection<V> values)

Prepend values to key.

Specified by:

lPush in interface IListCommands<K,V>

Parameters:

key - must not be null.

values - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

1.5

See Also:

Redis Documentation: LPUSH

lPushx

public Long lPushx(K key,
                   V value)

Prepend values to key only if the list exists.

Specified by:

lPushx in interface IListCommands<K,V>

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LPUSHX

lSet

public void lSet(K key,
                 long index,
                 V value)

Set the value list element at index.

Specified by:

lSet in interface IListCommands<K,V>

Parameters:

key - must not be null.

index -

value -

See Also:

Redis Documentation: LSET

lRem

public Long lRem(K key,
                 long count,
                 V value)

Removes the first count occurrences of value from the list stored at key.

Specified by:

lRem in interface IListCommands<K,V>

Parameters:

key - must not be null.

count -

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LREM

lRange

public List<V> lRange(K key,
                      long start,
                      long end)

Get elements between begin and end from list at key.

Specified by:

lRange in interface IListCommands<K,V>

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: LRANGE

ltrim

public void ltrim(K key,
                  long start,
                  long end)

Trim list at key to elements between start and end.

Specified by:

ltrim in interface IListCommands<K,V>

Parameters:

key - must not be null.

start -

end -

See Also:

Redis Documentation: LTRIM

rPop

public V rPop(K key)

Removes and returns last element in list stored at key.

Specified by:

rPop in interface IListCommands<K,V>

Parameters:

key - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: RPOP

rPoplPush

public V rPoplPush(K srcKey,
                   K dstKey)

Remove the last element from list at sourceKey, append it to destinationKey and return its value.

Specified by:

rPoplPush in interface IListCommands<K,V>

Parameters:

srcKey - must not be null.

dstKey - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: RPOPLPUSH

brPoplPush

public V brPoplPush(K srcKey,
                    K dstKey,
                    long timeoutSeconds)

Remove the last element from list at srcKey, append it to dstKey and return its value.
Blocks connection until element available or timeoutSeconds reached.

Specified by:

brPoplPush in interface IListCommands<K,V>

Parameters:

srcKey - must not be null.

dstKey - must not be null.

timeoutSeconds -

Returns:

can be null.

See Also:

Redis Documentation: BRPOPLPUSH

rPush

public Long rPush(K key,
                  V value)

Append value to key.

Specified by:

rPush in interface IListCommands<K,V>

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

rPush

public Long rPush(K key,
                  V... values)

Append values to key.

Specified by:

rPush in interface IListCommands<K,V>

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

rPush

public Long rPush(K key,
                  Collection<V> values)

Append values to key.

Specified by:

rPush in interface IListCommands<K,V>

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSH

rPushx

public Long rPushx(K key,
                   V value)

Append values to key only if the list exists.

Specified by:

rPushx in interface IListCommands<K,V>

Parameters:

key - must not be null.

value -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: RPUSHX

blPop

public V blPop(K key,
               long timeoutSeconds)

Removes and returns first element from lists stored at key .
Blocks connection until element available or timeoutSeconds reached.

Specified by:

blPop in interface IListCommands<K,V>

Parameters:

key - must not be null.

timeoutSeconds -

Returns:

can be null.

See Also:

Redis Documentation: BLPOP

brPop

public V brPop(K key,
               long timeoutSeconds)

Removes and returns last element from lists stored at key.
Blocks connection until element available or timeoutSeconds reached.

Specified by:

brPop in interface IListCommands<K,V>

Parameters:

key - must not be null.

timeoutSeconds -

Returns:

can be null.

See Also:

Redis Documentation: BRPOP

sAdd

public Long sAdd(K key,
                 V... values)

Add given values to set at key.

Specified by:

sAdd in interface ISetCommands<K,V>

Parameters:

key - must not be null.

values -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SADD

sCard

public Long sCard(K key)

Get size of set at key.

Specified by:

sCard in interface ISetCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SCARD

sPop

public V sPop(K key)

Remove and return a random member from set at key.

Specified by:

sPop in interface ISetCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SPOP

sMembers

public Set<V> sMembers(K key)

Get all elements of set at key.

Specified by:

sMembers in interface ISetCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SMEMBERS

sIsMember

public Boolean sIsMember(K key,
                         Object member)

Check if set at key contains value.

Specified by:

sIsMember in interface ISetCommands<K,V>

Parameters:

key - must not be null.

member -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SISMEMBER

sInter

public Set<V> sInter(K key,
                     K otherKey)

Returns the members intersecting all given sets at key and otherKey.

Specified by:

sInter in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTER

sInter

public Set<V> sInter(K key,
                     Collection<K> otherKeys)

Returns the members intersecting all given sets at key and otherKeys.

Specified by:

sInter in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTER

sInterstore

public Long sInterstore(K key,
                        K otherKey,
                        K destKey)

Intersect all given sets at key and otherKey and store result in destKey.

Specified by:

sInterstore in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTERSTORE

sInterStore

public Long sInterStore(K key,
                        Collection<K> otherKeys,
                        K destKey)

Intersect all given sets at key and otherKeys and store result in destKey.

Specified by:

sInterStore in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTERSTORE

sRandMember

public V sRandMember(K key)

Get random element from set at key.

Specified by:

sRandMember in interface ISetCommands<K,V>

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SRANDMEMBER

sRandMember

public List<V> sRandMember(K key,
                           long count)

Get count random elements from set at key.

Specified by:

sRandMember in interface ISetCommands<K,V>

Parameters:

key - must not be null.

count - nr of members to return.

Returns:

empty List if key does not exist or null when used in pipeline / transaction.

Throws:

IllegalArgumentException - if count is negative.

See Also:

Redis Documentation: SRANDMEMBER

sRem

public Long sRem(K key,
                 Object... members)

Remove given values from set at key and return the number of removed elements.

Specified by:

sRem in interface ISetCommands<K,V>

Parameters:

key - must not be null.

members -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SREM

sUnion

public Set<V> sUnion(K key,
                     K otherKey)

Union all sets at given keys and otherKey.

Specified by:

sUnion in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNION

sUnion

public Set<V> sUnion(K key,
                     Collection<K> otherKeys)

Union all sets at given keys and otherKeys.

Specified by:

sUnion in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNION

sUnionStore

public Long sUnionStore(K key,
                        K otherKey,
                        K destKey)

Union all sets at given key and otherKey and store result in destKey.

Specified by:

sUnionStore in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNIONSTORE

sUnionStore

public Long sUnionStore(K key,
                        Collection<K> otherKeys,
                        K destKey)

Union all sets at given key and otherKeys and store result in destKey.

Specified by:

sUnionStore in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNIONSTORE

sDiff

public Set<V> sDiff(K key,
                    K otherKey)

Diff all sets for given key and otherKey.

Specified by:

sDiff in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFF

sDiff

public Set<V> sDiff(K key,
                    Collection<K> otherKeys)

Diff all sets for given key and otherKeys.

Specified by:

sDiff in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFF

sDiffStore

public Long sDiffStore(K key,
                       K otherKey,
                       K destKey)

Diff all sets for given key and otherKey and store result in destKey.

Specified by:

sDiffStore in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFFSTORE

sDiffStore

public Long sDiffStore(K key,
                       Collection<K> otherKeys,
                       K destKey)

Diff all sets for given key and otherKeys and store result in destKey.

Specified by:

sDiffStore in interface ISetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFFSTORE

zAdd

public Boolean zAdd(K key,
                    V member,
                    double score)

Add member to a sorted set at key, or update its score if it already exists.

Specified by:

zAdd in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

member - the member.

score - the score.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZADD

zAdd

public Long zAdd(K key,
                 Map<V,Double> scoreMembers)

Add scoreMembers to a sorted set at key, or update its score if it already exists.

Specified by:

zAdd in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

scoreMembers - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZADD

zCard

public Long zCard(K key)

Returns the number of elements of the sorted set stored with given key.

Specified by:

zCard in interface IZSetCommands<K,V>

Parameters:

key -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZCARD

zCount

public Long zCount(K key,
                   double min,
                   double max)

Count number of elements within sorted set with scores between min and max.

Specified by:

zCount in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZCOUNT

zIncrby

public Double zIncrby(K key,
                      V member,
                      double score)

Increment the score of element with member in sorted set by score.

Specified by:

zIncrby in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

member - the member.

score -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINCRBY

zRange

public Set<V> zRange(K key,
                     long start,
                     long end)

Get elements between start and end from sorted set.

Specified by:

zRange in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGE

zRevRange

public Set<V> zRevRange(K key,
                        long start,
                        long end)

Get elements in range from start to end from sorted set ordered from high to low.

Specified by:

zRevRange in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGE

zRangeByScore

public Set<V> zRangeByScore(K key,
                            double min,
                            double max)

Get elements where score is between min and max from sorted set.

Specified by:

zRangeByScore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

zRank

public Long zRank(K key,
                  Object member)

Determine the index of element with value in a sorted set.

Specified by:

zRank in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

member - the member.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANK

zRevRank

public Long zRevRank(K key,
                     Object member)

Determine the index of element with member in a sorted set when scored high to low.

Specified by:

zRevRank in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

member - the member.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANK

zRem

public Long zRem(K key,
                 Object... members)

Remove values from sorted set. Return number of removed elements.

Specified by:

zRem in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

members - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREM

zScore

public Double zScore(K key,
                     Object member)

Get the score of element with member from sorted set with key key.

Specified by:

zScore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

member - the member.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZSCORE

zRangeByScore

public Set<V> zRangeByScore(K key,
                            double min,
                            double max,
                            long offset,
                            long count)

Get elements in range from min to max where score is between min and max from sorted set.

Specified by:

zRangeByScore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

min -

max -

offset -

count -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

zRevRange

public Set<V> zRevRange(K key,
                        double min,
                        double max)

Get elements where score is between min and max from sorted set ordered from high to low.

Specified by:

zRevRange in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGE

zRevRangeByScore

public Set<V> zRevRangeByScore(K key,
                               double min,
                               double max,
                               long offset,
                               long count)

Get elements in range from start to end where score is between min and max from sorted set ordered high -> low.

Specified by:

zRevRangeByScore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

min -

max -

offset -

count -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGEBYSCORE

zRemRangeByRank

public Long zRemRangeByRank(K key,
                            long start,
                            long end)

Remove elements in range between start and end from sorted set with key.

Specified by:

zRemRangeByRank in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREMRANGEBYRANK

zRemRangeByScore

public Long zRemRangeByScore(K key,
                             double min,
                             double max)

Remove elements with scores between min and max from sorted set with key.

Specified by:

zRemRangeByScore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREMRANGEBYSCORE

zUnionStore

public Long zUnionStore(K key,
                        K otherKey,
                        K destKey)

Union sorted sets at key and otherKeys and store result in destination destKey.

Specified by:

zUnionStore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZUNIONSTORE

zUnionStore

public Long zUnionStore(K key,
                        Collection<K> otherKeys,
                        K destKey)

Union sorted sets at key and otherKeys and store result in destination destKey.

Specified by:

zUnionStore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZUNIONSTORE

zUnionStore

public Long zUnionStore(K key,
                        Collection<K> otherKeys,
                        K destKey,
                        org.springframework.data.redis.connection.RedisZSetCommands.Aggregate aggregate,
                        org.springframework.data.redis.connection.RedisZSetCommands.Weights weights)

Union sorted sets at key and otherKeys and store result in destination destKey.

Specified by:

zUnionStore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZUNIONSTORE

zInterStore

public Long zInterStore(K key,
                        K otherKey,
                        K destKey)

Intersect sorted sets at key and otherKey and store result in destination destKey.

Specified by:

zInterStore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINTERSTORE

zInterStore

public Long zInterStore(K key,
                        Collection<K> otherKeys,
                        K destKey)

Intersect sorted sets at key and otherKeys and store result in destination destKey.

Specified by:

zInterStore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINTERSTORE

zInterStore

public Long zInterStore(K key,
                        Collection<K> otherKeys,
                        K destKey,
                        org.springframework.data.redis.connection.RedisZSetCommands.Aggregate aggregate,
                        org.springframework.data.redis.connection.RedisZSetCommands.Weights weights)

Intersect sorted sets at key and otherKeys and store result in destination destKey.

Specified by:

zInterStore in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINTERSTORE

zScan

public org.springframework.data.redis.core.Cursor<org.springframework.data.redis.core.ZSetOperations.TypedTuple<V>> zScan(K key,
                                                                                                                          org.springframework.data.redis.core.ScanOptions options)

Iterate over elements in zset at key.
Important: Call Closeable.close() when done to avoid resource leak.

Specified by:

zScan in interface IZSetCommands<K,V>

Parameters:

key -

options -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZSCAN

zRangeByLex

public Set<V> zRangeByLex(K key,
                          org.springframework.data.redis.connection.RedisZSetCommands.Range range)

Get all elements with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range#getMin() and RedisZSetCommands.Range#getMax().

Specified by:

zRangeByLex in interface IZSetCommands<K,V>

Parameters:

key - must not be null.

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

1.7

See Also:

Redis Documentation: ZRANGEBYLEX

zRangeByLex

public Set<V> zRangeByLex(K key,
                          org.springframework.data.redis.connection.RedisZSetCommands.Range range,
                          org.springframework.data.redis.connection.RedisZSetCommands.Limit limit)

Get all elements n elements, where n = RedisZSetCommands.Limit#getCount(), starting at RedisZSetCommands.Limit#getOffset() with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range#getMin() and RedisZSetCommands.Range#getMax().

Specified by:

zRangeByLex in interface IZSetCommands<K,V>

Parameters:

key - must not be null

range - must not be null.

limit - can be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYLEX

geoAdd

public Long geoAdd(K key,
                   org.springframework.data.geo.Point point,
                   V member)

Add Point with given member name to key.

Specified by:

geoAdd in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

point - must not be null.

member - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

geoAdd

public Long geoAdd(K key,
                   org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V> location)

Add RedisGeoCommands.GeoLocation to key.

Specified by:

geoAdd in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

geoAdd

public Long geoAdd(K key,
                   Map<V,org.springframework.data.geo.Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Specified by:

geoAdd in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

memberCoordinateMap - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

geoAdd

public Long geoAdd(K key,
                   Iterable<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>> geoLocations)

Add RedisGeoCommands.GeoLocations to key

Specified by:

geoAdd in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

geoLocations - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

geoDist

public org.springframework.data.geo.Distance geoDist(K key,
                                                     V member1,
                                                     V member2)

Get the Distance between member1 and member2.

Specified by:

geoDist in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: GEODIST

geoDist

public org.springframework.data.geo.Distance geoDist(K key,
                                                     V member1,
                                                     V member2,
                                                     org.springframework.data.geo.Metric metric)

Get the Distance between member1 and member2 in the given Metric.

Specified by:

geoDist in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

metric - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: GEODIST

geoHash

public List<String> geoHash(K key,
                            V... members)

Get Geohash representation of the position for one or more members.

Specified by:

geoHash in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEOHASH

geoPos

public List<org.springframework.data.geo.Point> geoPos(K key,
                                                       V... members)

Get the Point representation of positions for one or more members.

Specified by:

geoPos in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEOPOS

geoRadius

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>> geoRadius(K key,
                                                                                                                                    org.springframework.data.geo.Circle within)

Get the members within the boundaries of a given Circle.

Specified by:

geoRadius in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUS

geoRadius

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>> geoRadius(K key,
                                                                                                                                    org.springframework.data.geo.Circle within,
                                                                                                                                    org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.

Specified by:

geoRadius in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

within - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUS

geoRadiusByMember

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>> geoRadiusByMember(K key,
                                                                                                                                            V member,
                                                                                                                                            double radius)

Get the members within the circle defined by the members coordinates and given radius.

Specified by:

geoRadiusByMember in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

member - must not be null.

radius -

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>> geoRadiusByMember(K key,
                                                                                                                                            V member,
                                                                                                                                            org.springframework.data.geo.Distance distance)

Get the members within the circle defined by the members coordinates and given radius applying Metric.

Specified by:

geoRadiusByMember in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<V>> geoRadiusByMember(K key,
                                                                                                                                            V member,
                                                                                                                                            org.springframework.data.geo.Distance distance,
                                                                                                                                            org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.

Specified by:

geoRadiusByMember in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRemove

public Long geoRemove(K key,
                      V... members)

Remove the members.

Specified by:

geoRemove in interface IGeoCommands<K,V>

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of elements removed. null when used in pipeline / transaction.

pfAdd

public Long pfAdd(K key,
                  V... values)

Adds the given values to the key.

Specified by:

pfAdd in interface IHyperLogLogCommands<K,V>

Parameters:

key - must not be null.

values - must not be null.

Returns:

1 of at least one of the values was added to the key; 0 otherwise. null when used in pipeline / transaction.

See Also:

Redis Documentation: PFADD

pfCount

public Long pfCount(K... keys)

Gets the current number of elements within the key.

Specified by:

pfCount in interface IHyperLogLogCommands<K,V>

Parameters:

keys - must not be null or empty.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: PFCOUNT

pfMerge

public Long pfMerge(K destination,
                    K... sourceKeys)

Merges all values of given sourceKeys into destination key.

Specified by:

pfMerge in interface IHyperLogLogCommands<K,V>

Parameters:

destination - key of HyperLogLog to move source keys into.

sourceKeys - must not be null or empty.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: PFMERGE

unlink

public Boolean unlink(K key)

Unlink the key from the keyspace. Unlike with IValueCommands.del(Object) the actual memory reclaiming here happens asynchronously.

Specified by:

unlink in interface IRedisCommands<K,V>

Parameters:

key - must not be null.

Returns:

The number of keys that were removed. null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: UNLINK

unlink

public Long unlink(Collection<K> keys)

Unlink the keys from the keyspace. Unlike with IValueCommands.del(Collection) the actual memory reclaiming here happens asynchronously.

Specified by:

unlink in interface IRedisCommands<K,V>

Parameters:

keys - must not be null.

Returns:

The number of keys that were removed. null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: UNLINK

move

public Boolean move(K key,
                    int dbIndex)

Move given key to database with index.

Specified by:

move in interface IRedisCommands<K,V>

Parameters:

key - must not be null.

dbIndex -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: MOVE

sort

public List<V> sort(org.springframework.data.redis.core.query.SortQuery<K> query)

Sort the elements for query.

Specified by:

sort in interface IRedisCommands<K,V>

Parameters:

query - must not be null.

Returns:

the results of sort. null when used in pipeline / transaction.

See Also:

Redis Documentation: SORT

sort

public <T> List<T> sort(org.springframework.data.redis.core.query.SortQuery<K> query,
                        org.springframework.data.redis.serializer.RedisSerializer<T> resultSerializer)

Sort the elements for query applying RedisSerializer.

Specified by:

sort in interface IRedisCommands<K,V>

Parameters:

query - must not be null.

resultSerializer -

Returns:

the deserialized results of sort. null when used in pipeline / transaction.

See Also:

Redis Documentation: SORT

sort

public <T> List<T> sort(org.springframework.data.redis.core.query.SortQuery<K> query,
                        org.springframework.data.redis.core.BulkMapper<T,V> bulkMapper)

Sort the elements for query applying BulkMapper.

Specified by:

sort in interface IRedisCommands<K,V>

Parameters:

query - must not be null.

bulkMapper -

Returns:

the deserialized results of sort. null when used in pipeline / transaction.

See Also:

Redis Documentation: SORT

sort

public <T,S> List<T> sort(org.springframework.data.redis.core.query.SortQuery<K> query,
                          org.springframework.data.redis.core.BulkMapper<T,S> bulkMapper,
                          org.springframework.data.redis.serializer.RedisSerializer<S> resultSerializer)

Sort the elements for query applying BulkMapper and RedisSerializer.

Specified by:

sort in interface IRedisCommands<K,V>

Parameters:

query - must not be null.

bulkMapper -

resultSerializer -

Returns:

the deserialized results of sort. null when used in pipeline / transaction.

See Also:

Redis Documentation: SORT

sort

public Long sort(org.springframework.data.redis.core.query.SortQuery<K> query,
                 K storeKey)

Sort the elements for query and store result in storeKey.

Specified by:

sort in interface IRedisCommands<K,V>

Parameters:

query - must not be null.

storeKey - must not be null.

Returns:

number of values. null when used in pipeline / transaction.

See Also:

Redis Documentation: SORT

execute

public <T> T execute(SessionCallbackX session)

Executes a Redis session. Allows multiple operations to be executed in the same session enabling 'transactional' capabilities through multi() and watch(Collection) operations.

Specified by:

execute in interface IRedisCommands<K,V>

Type Parameters:

T - return type

Parameters:

session - session callback. Must not be null.

Returns:

result object returned by the action or null

executePipelined

public List<Object> executePipelined(SessionCallbackX session)

Executes the given Redis session on a pipelined connection. Allows transactions to be pipelined. Note that the callback cannot return a non-null value as it gets overwritten by the pipeline.

Specified by:

executePipelined in interface IRedisCommands<K,V>

Parameters:

session - Session callback

Returns:

list of objects returned by the pipeline

executePipelined

public List<Object> executePipelined(SessionCallbackX session,
                                     org.springframework.data.redis.serializer.RedisSerializer<?> resultSerializer)

Executes the given Redis session on a pipelined connection, returning the results using a dedicated serializer. Allows transactions to be pipelined. Note that the callback cannot return a non-null value as it gets overwritten by the pipeline.

Specified by:

executePipelined in interface IRedisCommands<K,V>

Parameters:

session - Session callback

resultSerializer -

Returns:

list of objects returned by the pipeline

watch

public void watch(K key)

Watch given key for modifications during transaction started with multi().

Specified by:

watch in interface IRedisTransactionsCommands<K,V>

Parameters:

key - must not be null.

See Also:

Redis Documentation: WATCH

watch

public void watch(Collection<K> keys)

Watch given keys for modifications during transaction started with multi().

Specified by:

watch in interface IRedisTransactionsCommands<K,V>

Parameters:

keys - must not be null.

See Also:

Redis Documentation: WATCH

unwatch

public void unwatch()

Flushes all the previously watch(Object) keys.

Specified by:

unwatch in interface IRedisTransactionsCommands<K,V>

See Also:

Redis Documentation: UNWATCH

multi

public void multi()

Mark the start of a transaction block.
Commands will be queued and can then be executed by calling exec() or rolled back using discard()

Specified by:

multi in interface IRedisTransactionsCommands<K,V>

See Also:

Redis Documentation: MULTI

discard

public void discard()

Discard all commands issued after multi().

Specified by:

discard in interface IRedisTransactionsCommands<K,V>

See Also:

Redis Documentation: DISCARD

exec

public List<Object> exec()

Executes all queued commands in a transaction started with multi().
If used along with watch(Object) the operation will fail if any of watched keys has been modified.

Specified by:

exec in interface IRedisTransactionsCommands<K,V>

Returns:

List of replies for each executed command.

See Also:

Redis Documentation: EXEC

exec

public List<Object> exec(org.springframework.data.redis.serializer.RedisSerializer<?> valueSerializer)

Execute a transaction, using the provided RedisSerializer to deserialize any results that are byte[]s or Collections of byte[]s. If a result is a Map, the provided RedisSerializer will be used for both the keys and values. Other result types (Long, Boolean, etc) are left as-is in the converted results. Tuple results are automatically converted to TypedTuples.

Specified by:

exec in interface IRedisTransactionsCommands<K,V>

Parameters:

valueSerializer - The RedisSerializer to use for deserializing the results of transaction exec

Returns:

The deserialized results of transaction exec