Skip to content

DOC-7154: Clarify the SCH client-support table #4216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andy-stark-redis merged 1 commit into from
Oct 6, 2026
Merged

DOC-7154: Clarify the SCH client-support table #4216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/develop/clients/go/connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ for more information about SCH.

> [!NOTE]
> Using SCH with go-redis requires v9.16.0 or later for
> basic connections, and v9.18.0 or later for
> standard routing, and v9.18.0 or later for
> [OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md) connections.

By default, `go-redis` always attempts to connect via SCH but falls back to
Expand Down
2 changes: 1 addition & 1 deletion content/develop/clients/nodejs/connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ for more information about SCH.

> [!NOTE]
> Using SCH with node-redis requires v5.9.0 or later for
> basic connections, and v5.11.0 or later for
> standard routing, and v5.11.0 or later for
> [OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md) connections.

Use the configuration options shown in the example below to enable SCH
Expand Down
2 changes: 1 addition & 1 deletion content/develop/clients/redis-py/connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ for more information about SCH.

> [!NOTE]
> Using SCH with redis-py requires v7.0.0 or later for
> basic connections, and v7.2.0 or later for
> standard routing, and v7.2.0 or later for
> [OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md) connections.

By default, `redis-py` always attempts to connect via SCH but falls back to
Expand Down
31 changes: 16 additions & 15 deletions content/develop/clients/sch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,29 +63,30 @@ protocol, which is a requirement for SCH. However, you can
configure some parameters, such as the timeouts to use
during maintenance.

The table below lists the Redis client libraries that support SCH,
and the versions that added support for basic connections and
The following table lists the Redis client libraries that support SCH,
and the versions that added support for standard routing and for
[OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md) connections.
Standard routing covers any connection that doesn't use the OSS Cluster API.

| Client | Basic connection | OSS Cluster API | Client-side geographic failover |
| :-- | :-- | :-- | :-- |
| [redis-py](/content/develop/clients/redis-py/connect.md#connect-using-smart-client-handoffs-sch) | v7.0.0 | v7.2.0 | Disabled |
| [node-redis](/content/develop/clients/nodejs/connect.md#connect-using-smart-client-handoffs-sch) | v5.9.0 | v5.11.0 | Disabled |
| [Lettuce](/content/develop/clients/lettuce/connect.md#connect-using-smart-client-handoffs-sch) | v7.0.0 | - | Disabled |
| [go-redis](/content/develop/clients/go/connect.md#connect-using-smart-client-handoffs-sch) | v9.16.0 | v9.18.0 | Disabled |
| [StackExchange.Redis](/content/develop/clients/dotnet/connect.md#connect-using-smart-client-handoffs-sch) | v3.3.0 | v3.3.0 | Disabled |
| Client | Standard routing | OSS Cluster API |
| :-- | :-- | :-- |
| [redis-py](/content/develop/clients/redis-py/connect.md#connect-using-smart-client-handoffs-sch) | v7.0.0 | v7.2.0 |
| [node-redis](/content/develop/clients/nodejs/connect.md#connect-using-smart-client-handoffs-sch) | v5.9.0 | v5.11.0 |
| [Lettuce](/content/develop/clients/lettuce/connect.md#connect-using-smart-client-handoffs-sch) | v7.0.0 | - |
| [go-redis](/content/develop/clients/go/connect.md#connect-using-smart-client-handoffs-sch) | v9.16.0 | v9.18.0 |
| [StackExchange.Redis](/content/develop/clients/dotnet/connect.md#connect-using-smart-client-handoffs-sch) | v3.3.0 | v3.3.0 |

> [!NOTE]
> SCH is currently disabled when a client is configured for
> [Client-side geographic failover](/content/develop/clients/failover.md).
> Integration of the two features is planned for a future release.
 

> [!NOTE]
> SCH support in StackExchange.Redis is marked `[Experimental]`, so the API may
> still change. See
> [Connect using Smart client handoffs (SCH)](/content/develop/clients/dotnet/connect.md#connect-using-smart-client-handoffs-sch)
> for details.
 

> [!NOTE]
> SCH is currently disabled when a client is configured for
> [Client-side geographic failover](/content/develop/clients/failover.md).
> Integration of the two features is planned for a future release.

## SCH support in Redis server products

Expand Down
Loading