Skip to content

Conversation

@andy-stark-redis
Copy link
Contributor

Docs for the redis-py failover feature (there's a separate PR for Jedis failover; these are the only clients supporting the feature so far). At this draft stage, there's quite a bit of common content between both pages, especially in the description of failover concepts. We'll probably want to extract this out into a separate overview page when all the details of the feature are finalised.

@andy-stark-redis andy-stark-redis requested a review from a team October 24, 2025 11:56
@andy-stark-redis andy-stark-redis self-assigned this Oct 24, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2025

DOC-5849

@github-actions
Copy link
Contributor

Copy link
Contributor

@cmilesb cmilesb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Language looks good to me.


| Option | Description |
| --- | --- |
| `client_kwargs` | Keyword parameters to pass to the internal `RedisClient` constructor for this endpoint. Use it to specify the host, port, username, password, and other connection parameters (see [Connect to the server]({{< relref "/develop/clients/redis-py/connect" >}}) for more information). |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add here information how the different types of clients can be used - sync/async Redis and sync/async RedisCluster

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've expanded the description for this option, but I've also added a short section about using client_class to choose which client you want.

@andy-stark-redis
Copy link
Contributor Author

@cmilesb @petyaslavova Thanks for the reviews!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs do not merge yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants