Struct redis::cluster::ClusterClientBuilder

pub struct ClusterClientBuilder { /* fields omitted */ }

This is supported on crate feature cluster only.

Used to configure and build a ClusterClient.

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>

Builds a ClusterClient. Despite the name, this does not actually open a connection to Redis Cluster, but will perform some basic checks of the initial nodes’ URLs and passwords.

Errors

Upon failure to parse initial nodes or if the initial nodes have different passwords, 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 false). If readonly is true, all queries will go to replica nodes. If there are no replica nodes, queries will be issued to the primary nodes.