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

Interface IRedisCommands<K,V>

All Superinterfaces:

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

All Known Implementing Classes:

DistributedLockStore, IdempotentStore, RedisIdEngine, RedisStringKeyTemplateX, RedisTemplateX

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

IRedisCommands

Author:

Qicz

Method Summary

Modifier and Type	Method and Description
<T> T	execute(SessionCallbackX<T> 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	move(K key, int dbIndex) Move given key to database with index.
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.
Long	unlink(Collection<K> keys) Unlink the keys from the keyspace.
Boolean	unlink(K key) Unlink the key from the keyspace.

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

append, bitField, countExistingKeys, decr, decrBy, del, del, exists, expire, expireAt, get, getBit, getRange, getSet, incr, incrBy, mGet, mSet, mSet, persist, pExpire, rename, set, setBit, setEx, setEx, setNx, setNx, setNx, setRange, setXx, setXx, setXx, strLen, ttl, type

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

hDel, hExists, hGet, hGetAll, hKeys, hLen, hMget, hmset, hSet, hVals

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

blPop, brPop, brPoplPush, lIndex, lLen, lPop, lPush, lPush, lPush, lPushx, lRange, lRem, lSet, ltrim, rPop, rPoplPush, rPush, rPush, rPush, rPushx

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

sAdd, sCard, sDiff, sDiff, sDiffStore, sDiffStore, sInter, sInter, sInterStore, sInterstore, sIsMember, sMembers, sPop, sRandMember, sRandMember, sRem, sUnion, sUnion, sUnionStore, sUnionStore

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

zAdd, zAdd, zCard, zCount, zIncrby, zInterStore, zInterStore, zInterStore, zInterStore, zRange, zRangeByLex, zRangeByLex, zRangeByScore, zRangeByScore, zRank, zRem, zRemRangeByRank, zRemRangeByScore, zRevRange, zRevRange, zRevRangeByScore, zRevRank, zScan, zScore, zUnionStore, zUnionStore, zUnionStore, zUnionStore

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

geoAdd, geoAdd, geoAdd, geoAdd, geoDist, geoDist, geoHash, geoPos, geoRadius, geoRadius, geoRadiusByMember, geoRadiusByMember, geoRadiusByMember, geoRemove

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

pfAdd, pfCount, pfMerge

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

discard, exec, exec, multi, unwatch, watch, watch

Method Detail

unlink

@Nullable
Boolean unlink(K key)

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

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

@Nullable
Long unlink(Collection<K> keys)

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

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

@Nullable
Boolean move(K key,
                       int dbIndex)

Move given key to database with index.

Parameters:

key - must not be null.

dbIndex -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: MOVE

sort

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

Sort the elements for query.

Parameters:

query - must not be null.

Returns:

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

See Also:

Redis Documentation: SORT

sort

@Nullable
<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.

Parameters:

query - must not be null.

Returns:

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

See Also:

Redis Documentation: SORT

sort

@Nullable
<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.

Parameters:

query - must not be null.

Returns:

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

See Also:

Redis Documentation: SORT

sort

@Nullable
<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.

Parameters:

query - must not be null.

Returns:

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

See Also:

Redis Documentation: SORT

sort

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

Sort the elements for query and store result in storeKey.

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

@Nullable
<T> T execute(SessionCallbackX<T> session)

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

Type Parameters:

T - return type

Parameters:

session - session callback. Must not be null.

Returns:

result object returned by the action or null

executePipelined

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.

Parameters:

session - Session callback

Returns:

list of objects returned by the pipeline

executePipelined

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.

Parameters:

session - Session callback

resultSerializer -

Returns:

list of objects returned by the pipeline