com.lambdaworks.redis.cluster

Class RedisClusterClient

java.lang.Object

com.lambdaworks.redis.AbstractRedisClient

com.lambdaworks.redis.cluster.RedisClusterClient

public class RedisClusterClient
extends AbstractRedisClient

A scalable thread-safe Redis cluster client. Multiple threads may share one connection. The cluster client handles command routing based on the first key of the command and maintains a view on the cluster that is available when calling the getPartitions() method.

Connections to the cluster members are opened on the first access to the cluster node and managed by the StatefulRedisClusterConnection. You should not use transactional commands on cluster connections since MULTI, EXEC and DISCARD have no key and cannot be assigned to a particular node.

The Redis cluster client provides a sync, async and reactive API.

Connections to particular nodes can be obtained by StatefulRedisClusterConnection.getConnection(String) providing the node id or StatefulRedisClusterConnection.getConnection(String, int) by host and port.

Multiple keys operations have to operate on a key that hashes to the same slot. Following commands do not need to follow that rule since they are pipelined according its hash value to multiple nodes in parallel:

• DEL
• MGET
• MGET with streaming
• MSET
• MSETNX

Cluster commands can be issued to multiple hosts in parallel by using the NodeSelectionSupport API. A set of nodes is selected using a Predicate and commands can be issued to the node selection

   AsyncExecutions ping = commands.masters().commands().ping();
   Collection nodes = ping.nodes();
   nodes.stream().forEach(redisClusterNode -> ping.get(redisClusterNode));
 

RedisClusterClient is an expensive resource. Reuse this instance or the ClientResources as much as possible.

Since:

3.0

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	clusterTopologyRefreshActivated

Fields inherited from class com.lambdaworks.redis.AbstractRedisClient

BUF_ALLOCATOR, channels, clientOptions, clientResources, closeableResources, connectionEvents, eventLoopGroup, eventLoopGroups, genericWorkerPool, timeout, timer, unit

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedisClusterClient(ClientResources clientResources, Iterable<RedisURI> redisURIs) Initialize the client with a list of cluster URI's.
	RedisClusterClient(List<RedisURI> redisURIs) Deprecated. Use create(Iterable)
	RedisClusterClient(RedisURI initialUri) Deprecated. Use create(RedisURI)

Method Summary

Modifier and Type	Method and Description
StatefulRedisClusterConnection<String,String>	connect() Connect to a Redis Cluster and treat keys and values as UTF-8 strings.
<K,V> StatefulRedisClusterConnection<K,V>	connect(RedisCodec<K,V> codec) Connect to a Redis Cluster.
RedisAdvancedClusterCommands<String,String>	connectCluster() Deprecated. Use connect().sync()
<K,V> RedisAdvancedClusterCommands<K,V>	connectCluster(RedisCodec<K,V> codec) Deprecated. @deprecated Use connect(codec).sync()
RedisAdvancedClusterAsyncCommands<String,String>	connectClusterAsync() Deprecated. Use connect().async()
<K,V> RedisAdvancedClusterAsyncCommands<K,V>	connectClusterAsync(RedisCodec<K,V> codec) Deprecated. @deprecated Use connect(codec).async()
protected StatefulRedisConnection<String,String>	connectToNode(SocketAddress socketAddress)
static RedisClusterClient	create(ClientResources clientResources, Iterable<RedisURI> redisURIs) Create a new client that connects to the supplied uri with shared ClientResources.
static RedisClusterClient	create(ClientResources clientResources, RedisURI redisURI) Create a new client that connects to the supplied uri with shared ClientResources.
static RedisClusterClient	create(ClientResources clientResources, String uri) Create a new client that connects to the supplied uri with shared ClientResources.You need to shut down the ClientResources upon shutting down your application.
static RedisClusterClient	create(Iterable<RedisURI> redisURIs) Create a new client that connects to the supplied uri with default ClientResources.
static RedisClusterClient	create(RedisURI redisURI) Create a new client that connects to the supplied uri with default ClientResources.
static RedisClusterClient	create(String uri) Create a new client that connects to the supplied uri with default ClientResources.
protected <T extends Closeable> void	forEachCloseable(java.util.function.Predicate<? super Closeable> selector, java.util.function.Consumer<T> function)
protected void	forEachClusterConnection(java.util.function.Consumer<StatefulRedisClusterConnectionImpl<?,?>> function)
protected RedisURI	getFirstUri()
Partitions	getPartitions() Retrieve the cluster view.
ClientResources	getResources() Returns the ClientResources which are used with that client.
protected void	initializePartitions()
protected boolean	isEventLoopActive() Check if the AbstractRedisClient.genericWorkerPool is active
protected Partitions	loadPartitions() Retrieve partitions.
protected Utf8StringCodec	newStringStringCodec()
void	reloadPartitions() Reload partitions and re-initialize the distribution table.
void	setOptions(ClusterClientOptions clientOptions) Set the ClusterClientOptions for the client.
void	setPartitions(Partitions partitions) Sets the new cluster topology.
protected void	updatePartitionsInConnections()

Methods inherited from class com.lambdaworks.redis.AbstractRedisClient

addListener, channelType, connectAsyncImpl, connectionBuilder, getChannelCount, getOptions, getResourceCount, initializeChannel, removeListener, setDefaultTimeout, setOptions, shutdown, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

clusterTopologyRefreshActivated

protected AtomicBoolean clusterTopologyRefreshActivated

Constructor Detail

RedisClusterClient

@Deprecated
public RedisClusterClient(RedisURI initialUri)

Deprecated. Use create(RedisURI)

Initialize the client with an initial cluster URI.

Parameters:

initialUri - initial cluster URI

RedisClusterClient

@Deprecated
public RedisClusterClient(List<RedisURI> redisURIs)

Deprecated. Use create(Iterable)

Initialize the client with a list of cluster URI's. All uris are tried in sequence for connecting initially to the cluster. If any uri is successful for connection, the others are not tried anymore. The initial uri is needed to discover the cluster structure for distributing the requests.

Parameters:

redisURIs - iterable of initial cluster URIs. Must not be null and not empty.

RedisClusterClient

protected RedisClusterClient(ClientResources clientResources,
                             Iterable<RedisURI> redisURIs)

Initialize the client with a list of cluster URI's. All uris are tried in sequence for connecting initially to the cluster. If any uri is successful for connection, the others are not tried anymore. The initial uri is needed to discover the cluster structure for distributing the requests.

Parameters:

clientResources - the client resources. If null, the client will create a new dedicated instance of client resources and keep track of them.

redisURIs - iterable of initial cluster URIs. Must not be null and not empty.

Method Detail

create

public static RedisClusterClient create(RedisURI redisURI)

Create a new client that connects to the supplied uri with default ClientResources. You can connect to different Redis servers but you must supply a RedisURI on connecting.

Parameters:

redisURI - the Redis URI, must not be null

Returns:

a new instance of RedisClusterClient

create

public static RedisClusterClient create(Iterable<RedisURI> redisURIs)

Create a new client that connects to the supplied uri with default ClientResources. You can connect to different Redis servers but you must supply a RedisURI on connecting.

Parameters:

redisURIs - one or more Redis URI, must not be null and not empty

Returns:

a new instance of RedisClusterClient

create

public static RedisClusterClient create(String uri)

Create a new client that connects to the supplied uri with default ClientResources. You can connect to different Redis servers but you must supply a RedisURI on connecting.

Parameters:

uri - the Redis URI, must not be null

Returns:

a new instance of RedisClusterClient

create

public static RedisClusterClient create(ClientResources clientResources,
                                        RedisURI redisURI)

Create a new client that connects to the supplied uri with shared ClientResources. You need to shut down the ClientResources upon shutting down your application.You can connect to different Redis servers but you must supply a RedisURI on connecting.

Parameters:

clientResources - the client resources, must not be null

redisURI - the Redis URI, must not be null

Returns:

a new instance of RedisClusterClient

create

public static RedisClusterClient create(ClientResources clientResources,
                                        String uri)

Create a new client that connects to the supplied uri with shared ClientResources.You need to shut down the ClientResources upon shutting down your application. You can connect to different Redis servers but you must supply a RedisURI on connecting.

Parameters:

clientResources - the client resources, must not be null

uri - the Redis URI, must not be null

Returns:

a new instance of RedisClusterClient

create

public static RedisClusterClient create(ClientResources clientResources,
                                        Iterable<RedisURI> redisURIs)

Create a new client that connects to the supplied uri with shared ClientResources. You need to shut down the ClientResources upon shutting down your application.You can connect to different Redis servers but you must supply a RedisURI on connecting.

Parameters:

clientResources - the client resources, must not be null

redisURIs - one or more Redis URI, must not be null and not empty

Returns:

a new instance of RedisClusterClient

connect

public StatefulRedisClusterConnection<String,String> connect()

Connect to a Redis Cluster and treat keys and values as UTF-8 strings.

Returns:

A new stateful Redis Cluster connection

connect

public <K,V> StatefulRedisClusterConnection<K,V> connect(RedisCodec<K,V> codec)

Connect to a Redis Cluster. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type

V - Value type

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

A new stateful Redis Cluster connection

connectCluster

@Deprecated
public RedisAdvancedClusterCommands<String,String> connectCluster()

Deprecated. Use connect().sync()

Open a new synchronous connection to a Redis Cluster that treats keys and values as UTF-8 strings.

Returns:

A new connection

connectCluster

@Deprecated
public <K,V> RedisAdvancedClusterCommands<K,V> connectCluster(RedisCodec<K,V> codec)

Deprecated. @deprecated Use connect(codec).sync()

Open a new synchronous connection to a Redis Cluster. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type

V - Value type

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

A new connection

connectClusterAsync

@Deprecated
public RedisAdvancedClusterAsyncCommands<String,String> connectClusterAsync()

Deprecated. Use connect().async()

Open a new asynchronous connection to a Redis Cluster that treats keys and values as UTF-8 strings.

Returns:

A new connection

connectClusterAsync

@Deprecated
public <K,V> RedisAdvancedClusterAsyncCommands<K,V> connectClusterAsync(RedisCodec<K,V> codec)

Deprecated. @deprecated Use connect(codec).async()

Open a new asynchronous connection to a Redis Cluster. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type

V - Value type

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

A new connection

connectToNode

protected StatefulRedisConnection<String,String> connectToNode(SocketAddress socketAddress)

reloadPartitions

public void reloadPartitions()

Reload partitions and re-initialize the distribution table.

updatePartitionsInConnections

protected void updatePartitionsInConnections()

initializePartitions

protected void initializePartitions()

getPartitions

public Partitions getPartitions()

Retrieve the cluster view. Partitions are shared amongst all connections opened by this client instance.

Returns:

the partitions.

loadPartitions

protected Partitions loadPartitions()

Retrieve partitions. Nodes within Partitions are ordered by latency. Lower latency nodes come first.

Returns:

Partitions

isEventLoopActive

protected boolean isEventLoopActive()

Check if the AbstractRedisClient.genericWorkerPool is active

Returns:

false if the worker pool is terminating, shutdown or terminated

getFirstUri

protected RedisURI getFirstUri()

newStringStringCodec

protected Utf8StringCodec newStringStringCodec()

setPartitions

public void setPartitions(Partitions partitions)

Sets the new cluster topology. The partitions are not applied to existing connections.

Parameters:

partitions - partitions object

getResources

public ClientResources getResources()

Returns the ClientResources which are used with that client.

Returns:

the ClientResources for this client

forEachClusterConnection

protected void forEachClusterConnection(java.util.function.Consumer<StatefulRedisClusterConnectionImpl<?,?>> function)

forEachCloseable

protected <T extends Closeable> void forEachCloseable(java.util.function.Predicate<? super Closeable> selector,
                                                      java.util.function.Consumer<T> function)

setOptions

public void setOptions(ClusterClientOptions clientOptions)

Set the ClusterClientOptions for the client.

Parameters:

clientOptions - client options for the client and connections that are created after setting the options