Struct GlideClusterClient 

pub struct GlideClusterClient { /* private fields */ }

An async client for a cluster Valkey/Redis deployment.

Mirrors Python GlideClusterClient. Commands are routed automatically by the core based on their keys; use the *_with_route helpers (or crate::CustomCommand::custom_command_with_route) to override routing.

Implementations

impl GlideClusterClient

pub async fn connect( config: GlideClusterClientConfiguration, ) -> ValkeyResult<Self>

Connect using the given cluster configuration.

pub async fn get_pubsub_message(&self) -> ValkeyResult<PubSubMessage>

Wait for the next Pub/Sub message (including shard messages) on this client’s configured subscriptions.

pub async fn try_get_pubsub_message( &self, ) -> ValkeyResult<Option<PubSubMessage>>

Try to get the next Pub/Sub message without blocking. Returns None if no message is currently available.

pub async fn route_command( &self, cmd: Cmd, route: Route, ) -> ValkeyResult<ValkeyValue>

Execute a raw command with an explicit route.

pub async fn exec( &self, pipeline: &Pipeline, raise_on_error: bool, route: Option<Route>, options: &PipelineOptions, ) -> ValkeyResult<Vec<ValkeyValue>>

Execute a crate::Pipeline with GLIDE execution options, optionally routed. See crate::GlideClient::exec.

pub async fn update_connection_password( &self, password: Option<String>, immediate_auth: bool, ) -> ValkeyResult<()>

Update the password used by this client to authenticate with the cluster, without changing the server-side password (update_connection_password).

The new password is stored and used for all future (re)connections to every node. Pass None to clear a previously-set password. When immediate_auth is true, an AUTH is issued right away and the call errors if rejected; when false, it applies on the next reconnection.

Mirrors Python’s update_connection_password.

pub async fn cluster_scan( &self, cursor: &ClusterScanCursor, match_pattern: Option<&[u8]>, count: Option<u32>, object_type: Option<ObjectType>, ) -> ValkeyResult<(ClusterScanCursor, Vec<Bytes>)>

Incrementally iterate the entire keyspace of a cluster (SCAN for cluster). Returns the next ClusterScanCursor and the batch of keys found. Iteration is complete when the returned cursor’s ClusterScanCursor::is_finished is true.

Unlike standalone SCAN, the cluster scan is coordinated by glide-core across all shards using an opaque cursor.

Trait Implementations

impl Clone for GlideClusterClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandExecutor for GlideClusterClient

fn execute_command<'life0, 'async_trait>( &'life0 self, cmd: Cmd, route: Option<Route>, ) -> Pin<Box<dyn Future<Output = ValkeyResult<ValkeyValue>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute cmd, optionally routed to a specific node/set of nodes (cluster). Standalone implementations ignore route.