Struct redis::cluster::ClusterClientBuilder

pub struct ClusterClientBuilder { /* fields omitted */ }

This is supported on crate feature cluster only.

This is a ClusterClientBuilder of Redis cluster client.

Implementations

impl ClusterClientBuilder

pub fn new<T: IntoConnectionInfo>(initial_nodes: Vec<T>) -> ClusterClientBuilder

Generate the base configuration for new Client.

pub fn open(self) -> RedisResult<ClusterClient>

Connect to a redis cluster server and return a cluster client. This does not actually open a connection yet but it performs some basic checks on the URL. The password of initial nodes must be the same all.

Errors

If it is failed to parse initial_nodes or the initial nodes has different password, an error is returned.

pub fn password(self, password: String) -> ClusterClientBuilder

Set password for new ClusterClient.

pub fn readonly(self, readonly: bool) -> ClusterClientBuilder

Set read only mode for new ClusterClient. Default is not read only mode. When it is set to readonly mode, all query use replica nodes except there are no replica nodes. If there are no replica nodes, it use master node.