Package org.springframework.data.redis.connection

Interface RedisClusterConnection

All Superinterfaces:

AutoCloseable, DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterCommands, RedisClusterCommandsProvider, RedisClusterServerCommands, RedisCommands, RedisCommandsProvider, RedisConnection, RedisConnectionCommands, RedisGeoCommands, RedisHashCommands, RedisHyperLogLogCommands, RedisKeyCommands, RedisListCommands, RedisPubSubCommands, RedisScriptingCommands, RedisServerCommands, RedisSetCommands, RedisStreamCommands, RedisStringCommands, RedisTxCommands, RedisZSetCommands

All Known Implementing Classes:

JedisClusterConnection, LettuceClusterConnection

public interface RedisClusterConnection
extends RedisConnection, DefaultedRedisClusterConnection, RedisClusterCommandsProvider

RedisClusterConnection allows sending commands to dedicated nodes within the cluster. A RedisClusterNode can be obtained from RedisClusterCommands.clusterGetNodes() or it can be constructed using either host and RedisNode.getPort() or the node Id.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisClusterCommands

RedisClusterCommands.AddSlots

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisGeoCommands

RedisGeoCommands.DistanceUnit, RedisGeoCommands.GeoCommandArgs, RedisGeoCommands.GeoLocation<T>, RedisGeoCommands.GeoRadiusCommandArgs, RedisGeoCommands.GeoSearchCommandArgs, RedisGeoCommands.GeoSearchStoreCommandArgs

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisListCommands

RedisListCommands.Direction, RedisListCommands.Position

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisServerCommands

RedisServerCommands.FlushOption, RedisServerCommands.MigrateOption, RedisServerCommands.ShutdownOption

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisStreamCommands

RedisStreamCommands.XAddOptions, RedisStreamCommands.XClaimOptions, RedisStreamCommands.XPendingOptions

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisStringCommands

RedisStringCommands.BitOperation, RedisStringCommands.SetOption

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisZSetCommands

RedisZSetCommands.Limit, RedisZSetCommands.Range, RedisZSetCommands.ZAddArgs

Method Summary

Modifier and Type	Method	Description
default <T> T	execute(String command, byte[] key, Collection<byte[]> args)	Execute the given command for the key provided potentially appending args.
Set<byte[]>	keys(RedisClusterNode node, byte[] pattern)
String	ping(RedisClusterNode node)
byte[]	randomKey(RedisClusterNode node)
Cursor<byte[]>	scan(RedisClusterNode node, ScanOptions options)	Use a Cursor to iterate over keys.

Methods inherited from interface org.springframework.data.redis.connection.DefaultedRedisClusterConnection

bgReWriteAof, bgSave, dbSize, flushAll, flushAll, flushDb, flushDb, getClientList, getConfig, info, info, lastSave, resetConfigStats, rewriteConfig, save, setConfig, shutdown, time, time

Methods inherited from interface org.springframework.data.redis.connection.DefaultedRedisConnection

append, bgReWriteAof, bgSave, bitCount, bitCount, bitField, bitOp, bitPos, bLMove, bLPop, bRPop, bRPopLPush, bZPopMax, bZPopMin, copy, dbSize, decr, decrBy, del, dump, encodingOf, eval, evalSha, evalSha, exists, exists, expire, expireAt, flushAll, flushAll, flushDb, flushDb, geoAdd, geoAdd, geoAdd, geoDist, geoDist, geoHash, geoPos, geoRadius, geoRadius, geoRadiusByMember, geoRadiusByMember, geoRemove, geoSearch, geoSearchStore, get, getBit, getClientList, getClientName, getConfig, getDel, getEx, getRange, getSet, hDel, hExists, hGet, hGetAll, hIncrBy, hIncrBy, hKeys, hLen, hMGet, hMSet, hRandField, hRandField, hRandFieldWithValues, hRandFieldWithValues, hScan, hSet, hSetNX, hStrLen, hVals, idletime, incr, incrBy, incrBy, info, info, keys, killClient, lastSave, lIndex, lInsert, lLen, lMove, lPop, lPop, lPos, lPush, lPushX, lRange, lRem, lSet, lTrim, mGet, migrate, migrate, move, mSet, mSetNX, persist, pExpire, pExpireAt, pfAdd, pfCount, pfMerge, pSetEx, pTtl, pTtl, randomKey, refcount, rename, renameNX, replicaOf, replicaOfNoOne, resetConfigStats, restore, rewriteConfig, rPop, rPop, rPopLPush, rPush, rPushX, sAdd, save, scan, sCard, scriptExists, scriptFlush, scriptKill, scriptLoad, sDiff, sDiffStore, set, set, setBit, setClientName, setConfig, setEx, setNX, setRange, shutdown, shutdown, sInter, sInterStore, sIsMember, sMembers, sMIsMember, sMove, sort, sort, sPop, sPop, sRandMember, sRandMember, sRem, sScan, strLen, sUnion, sUnionStore, time, time, touch, ttl, ttl, type, unlink, xAck, xAdd, xClaim, xClaimJustId, xDel, xGroupCreate, xGroupCreate, xGroupDelConsumer, xGroupDestroy, xInfo, xInfoConsumers, xInfoGroups, xLen, xPending, xPending, xRange, xRange, xRead, xRead, xReadGroup, xReadGroup, xRevRange, xRevRange, xTrim, xTrim, zAdd, zAdd, zCard, zCount, zCount, zDiff, zDiffStore, zDiffWithScores, zIncrBy, zInter, zInterStore, zInterStore, zInterStore, zInterWithScores, zInterWithScores, zInterWithScores, zLexCount, zMScore, zPopMax, zPopMax, zPopMin, zPopMin, zRandMember, zRandMember, zRandMemberWithScore, zRandMemberWithScore, zRange, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeStoreByLex, zRangeStoreByScore, zRangeStoreRevByLex, zRangeStoreRevByScore, zRangeWithScores, zRank, zRem, zRemRange, zRemRangeByLex, zRemRangeByScore, zRemRangeByScore, zRevRange, zRevRangeByLex, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeWithScores, zRevRank, zScan, zScore, zUnion, zUnionStore, zUnionStore, zUnionStore, zUnionWithScores, zUnionWithScores, zUnionWithScores

Methods inherited from interface org.springframework.data.redis.connection.RedisClusterCommands

clusterAddSlots, clusterAddSlots, clusterCountKeysInSlot, clusterDeleteSlots, clusterDeleteSlotsInRange, clusterForget, clusterGetClusterInfo, clusterGetKeysInSlot, clusterGetMasterReplicaMap, clusterGetNodeForKey, clusterGetNodeForSlot, clusterGetNodes, clusterGetReplicas, clusterGetSlotForKey, clusterMeet, clusterReplicate, clusterSetSlot

Methods inherited from interface org.springframework.data.redis.connection.RedisClusterCommandsProvider

clusterCommands, serverCommands

Methods inherited from interface org.springframework.data.redis.connection.RedisCommands

execute

Methods inherited from interface org.springframework.data.redis.connection.RedisCommandsProvider

commands, geoCommands, hashCommands, hyperLogLogCommands, keyCommands, listCommands, scriptingCommands, setCommands, streamCommands, stringCommands, zSetCommands

Methods inherited from interface org.springframework.data.redis.connection.RedisConnection

close, closePipeline, getNativeConnection, getSentinelConnection, isClosed, isPipelined, isQueueing, openPipeline

Methods inherited from interface org.springframework.data.redis.connection.RedisConnectionCommands

echo, ping, select

Methods inherited from interface org.springframework.data.redis.connection.RedisGeoCommands

geoAdd, geoRadiusByMember

Methods inherited from interface org.springframework.data.redis.connection.RedisKeyCommands

restore, scan

Methods inherited from interface org.springframework.data.redis.connection.RedisListCommands

lPos

Methods inherited from interface org.springframework.data.redis.connection.RedisPubSubCommands

getSubscription, isSubscribed, pSubscribe, publish, subscribe

Methods inherited from interface org.springframework.data.redis.connection.RedisStreamCommands

xAck, xAdd, xAdd, xClaim, xDel, xGroupDelConsumer, xPending, xPending, xPending, xPending, xPending

Methods inherited from interface org.springframework.data.redis.connection.RedisStringCommands

bitPos

Methods inherited from interface org.springframework.data.redis.connection.RedisTxCommands

discard, exec, multi, unwatch, watch

Methods inherited from interface org.springframework.data.redis.connection.RedisZSetCommands

zAdd, zAdd, zRangeByLex, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeByScoreWithScores, zRangeByScoreWithScores, zRangeStoreByLex, zRangeStoreByScore, zRangeStoreRevByLex, zRangeStoreRevByScore, zRevRangeByLex, zRevRangeByLex, zRevRangeByScore, zRevRangeByScore, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores

Method Details

ping

@Nullable
String ping(RedisClusterNode node)

Parameters:

node - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• RedisConnectionCommands.ping()

keys

@Nullable
Set<byte[]> keys(RedisClusterNode node,
 byte[] pattern)

Parameters:

node - must not be null.

pattern - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• RedisKeyCommands.keys(byte[])

scan

Cursor<byte[]> scan(RedisClusterNode node,
 ScanOptions options)

Use a Cursor to iterate over keys.

Parameters:

node - must not be null.

options - must not be null.

Returns:

never null.

Since:

2.1

See Also:

• Redis Documentation: SCAN

randomKey

@Nullable
byte[] randomKey(RedisClusterNode node)

Parameters:

node - must not be null.

Returns:

null when no keys stored at node or when used in pipeline / transaction.

See Also:

• RedisKeyCommands.randomKey()

execute

@Nullable
default <T> T execute(String command,
 byte[] key,
 Collection<byte[]> args)

Execute the given command for the key provided potentially appending args.
This method, other than RedisCommands.execute(String, byte[]...), dispatches the command to the key serving master node.

 
 // SET foo bar EX 10 NX
 execute("SET", "foo".getBytes(), asBinaryList("bar", "EX", 10, "NX"))
 
 

Parameters:

command - must not be null.

key - must not be null.

args - must not be null.

Returns:

command result as delivered by the underlying Redis driver. Can be null.

Since:

2.1