Struct redis::cluster::ClusterClientBuilder

pub struct ClusterClientBuilder { /* private fields */ }

Available 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

Creates a new ClusterClientBuilder with the provided initial_nodes.

This is the same as ClusterClient::builder(initial_nodes).

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

Creates a new ClusterClient from the parameters.

This does not create connections to the Redis Cluster, but only performs some basic checks on the initial nodes’ URLs and passwords/usernames.

Errors

Upon failure to parse initial nodes or if the initial nodes have different passwords or usernames, an error is returned.

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

Sets password for the new ClusterClient.

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

Sets username for the new ClusterClient.

pub fn retries(self, retries: u32) -> ClusterClientBuilder

Sets number of retries for the new ClusterClient.

pub fn max_retry_wait(self, max_wait: u64) -> ClusterClientBuilder

Sets maximal wait time in millisceonds between retries for the new ClusterClient.

pub fn min_retry_wait(self, min_wait: u64) -> ClusterClientBuilder

Sets minimal wait time in millisceonds between retries for the new ClusterClient.

pub fn retry_wait_formula( self, factor: u64, exponent_base: u64 ) -> ClusterClientBuilder

Sets the factor and exponent base for the retry wait time. The formula for the wait is rand(min_wait_retry .. min(max_retry_wait , factor * exponent_base ^ retry))ms.

pub fn tls(self, tls: TlsMode) -> ClusterClientBuilder

Sets TLS mode for the new ClusterClient.

It is extracted from the first node of initial_nodes if not set.

pub fn read_from_replicas(self) -> ClusterClientBuilder

Enables reading from replicas for all new connections (default is disabled).

If enabled, then read queries will go to the replica nodes & write queries will go to the primary nodes. If there are no replica nodes, then all queries will go to the primary nodes.

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

👎Deprecated since 0.22.0: Use build()

Use build().

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

👎Deprecated since 0.22.0: Use read_from_replicas()

Use read_from_replicas().