-
Notifications
You must be signed in to change notification settings - Fork 88
Python wrapper
GLIDE for Redis provides support for both Redis Cluster and Redis Standalone and configurations. Please refer to the relevant section based on your specific setup.
GLIDE for Redis supports Redis Cluster deployments, where the Redis database is partitioned across multiple primary Redis shards, with each shard being represented by a primary node and zero or more replica nodes..
To initialize a RedisClusterClient, you need to provide a ClusterClientConfiguration that includes the addresses of initial seed nodes. GLIDE for Redis automatically discovers the entire cluster topology, eliminating the necessity of explicitly listing all cluster nodes.
The NodeAddress class represents the host and port of a Redis node. The host can be either an IP address, a hostname, or a fully qualified domain name (FQDN).
addresses = [NodeAddress(host="redis.example.com", port=6379)]
client_config = ClusterClientConfiguration(addresses)
client = await RedisClusterClient.create(client_config)In the Redis cluster, data is divided into slots, and each primary node within the cluster is responsible for specific slots. GLIDE for Redis adheres to Redis OSS guidelines when determining the node(s) to which a command should be sent in clustering mode.
For more details on the routing of specific commands, please refer to the documentation within the code.
When requests are dispatched to multiple shards in a cluster (as discussed in the Request routing section), the Redis client needs to aggregate the responses for a given command. GLIDE for Redis follows Redis OSS guidelines for determining how to aggregate the responses from multiple shards within a cluster.
To learn more about response aggregation for specific commands, please refer to the documentation within the code.
The cluster's topology can change over time. New nodes can be added or removed, and the primary node owning a specific slot may change. GLIDE for Redis is designed to automatically rediscover the topology whenever Redis indicates a change in slot ownership. This ensures that the GLIDE for Redis client stays in sync with the cluster's topology.
GLIDE for Redis also supports Redis Standalone deployments, where the Redis database is hosted on a single primary node, optionally with replica nodes. To initialize a RedisClient for a standalone Redis setup, you should create a RedisClientConfiguration that includes the addresses of primary and all replica nodes.
addresses = [
NodeAddress(host="redis_primary.example.com", port=6379),
NodeAddress(host="redis_replica1.example.com", port=6379),
NodeAddress(host="redis_replica2.example.com", port=6379)
]
client_config = RedisClientConfiguration(addresses)
client = await RedisClient.create(client_config)For information on the supported commands and their corresponding parameters, we recommend referring to the documentation in the code. This documentation provides in-depth insights into the usage and options available for each command.
By default, when connecting to Redis, GLIDE for Redis operates in an unauthenticated mode.
GLIDE for Redis also offers support for an authenticated connection mode.
In authenticated mode, you have the following options:
- Use both a username and password, which is recommended and configured through ACLs on the Redis server.
- Use a password only, which is applicable if Redis is configured with the requirepass setting.
To provide the necessary authentication credentials to the client, you can use the RedisCredentials class.
addresses = [NodeAddress(host="redis.example.com", port=6379)]
credentials = RedisCredentials("passwordA", "user1")
client_config = ClusterClientConfiguration(addresses, credentials=credentials)
client = await RedisClusterClient.create(client_config)addresses = [NodeAddress(host="redis.example.com", port=6379)]
credentials = RedisCredentials("passwordA", "user1")
client_config = RedisClientConfiguration(addresses, credentials=credentials)
client = await RedisClient.create(client_config)GLIDE for Redis supports secure TLS connections to a Redis data store.
It's important to note that TLS support in GLIDE for Redis relies on rusttls. Currently, GLIDE for Redis employs the default rustls settings with no option for customization.
addresses = [NodeAddress(host="redis.example.com", port=6379)]
client_config = ClusterClientConfiguration(addresses, use_tls=True)
client = await RedisClusterClient.create(client_config)addresses = [NodeAddress(host="redis.example.com", port=6379)]
client_config = RedisClientConfiguration(addresses, use_tls=True)
client = await RedisClient.create(client_config)By default, GLIDE for Redis directs read commands to the primary node that owns a specific slot. For applications that prioritize read throughput and can tolerate possibly stale data, GLIDE for Redis provides the flexibility to route reads to replica nodes.
GLIDE for Redis provides support for next read strategies, allowing you to choose the one that best fits your specific use case.
| Strategy | Description |
|---|---|
PRIMARY |
Always read from primary, in order to get the freshest data |
PREFER_REPLICA |
Spread requests between all replicas in a round robin manner. If no replica is available, route the requests to the primary |
addresses = [NodeAddress(host="redis.example.com", port=6379)]
client_config = ClusterClientConfiguration(addresses)
client = await RedisClusterClient.create(client_config, read_from=ReadFrom.PREFER_REPLICA)
await client.set("key1", "val1")
# get will read from one of the replicas
await client.get("key1")GLIDE for Redis allows you to configure timeout settings and reconnect strategies. These configurations can be applied through the ClusterClientConfiguration and RedisClientConfiguration parameters.
| Configuration setting | Description | Default value |
|---|---|---|
| request_timeout | This specified time duration, measured in milliseconds, represents the period during which the client will await the completion of a request. This time frame includes the process of sending the request, waiting for a response from the Redis node(s), and any necessary reconnection or retry attempts. If a pending request exceeds the specified timeout, it will trigger a timeout error. If no timeout value is explicitly set, a default value will be employed. | 250 milliseconds |
| reconnect_strategy | The reconnection strategy defines how and when reconnection attempts are made in the event of connection failures | Exponential backoff |
Notes:
- In the case of Redis Standalone, the only reconnect strategy currently supported is exponential backoff.
- Regarding Redis Cluster, an exponential backoff strategy is currently in the process of being developed. In the event of a disconnection, a single reconnect attempt is initiated per request.
addresses = [NodeAddress(host="redis.example.com", port=6379)]
client_config = ClusterClientConfiguration(addresses, request_timeout=500)
client = await RedisClusterClient.create(client_config)