Skip to content

Commit 4f5c5d2

Browse files
Merge pull request #3339 from redis/DOC-6627-sch-client-versions
DOC-6627 noted minimum versions of clients that support SCH
2 parents dfc79b5 + dfe5e78 commit 4f5c5d2

5 files changed

Lines changed: 28 additions & 5 deletions

File tree

content/develop/clients/go/connect.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,11 @@ lets a client take action to avoid disruptions in service.
136136
See [Smart client handoffs]({{< relref "/develop/clients/sch" >}})
137137
for more information about SCH.
138138

139+
{{< note >}}Using SCH with go-redis requires v9.16.0 or later for
140+
basic connections, and v9.18.0 or later for
141+
[OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}) connections.
142+
{{< /note >}}
143+
139144
By default, `go-redis` always attempts to connect via SCH but falls back to
140145
a non-SCH connection if the server doesn't support it. However, you can configure SCH
141146
explicitly by passing a `MaintNotificationsConfig` object during the connection,

content/develop/clients/lettuce/connect.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,9 @@ lets a client take action to avoid disruptions in service.
264264
See [Smart client handoffs]({{< relref "/develop/clients/sch" >}})
265265
for more information about SCH.
266266

267+
{{< note >}}Support for SCH in Lettuce requires v7.0.0 or later.
268+
{{< /note >}}
269+
267270
By default, `Lettuce` always attempts to connect via SCH but falls back to
268271
a non-SCH connection if the server doesn't support it. However, you can configure SCH
269272
explicitly by creating a `MaintNotificationsConfig` object and/or a `TimeoutOptions`

content/develop/clients/nodejs/connect.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,11 @@ lets a client take action to avoid disruptions in service.
338338
See [Smart client handoffs]({{< relref "/develop/clients/sch" >}})
339339
for more information about SCH.
340340

341+
{{< note >}}Using SCH with node-redis requires v5.9.0 or later for
342+
basic connections, and v5.11.0 or later for
343+
[OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}) connections.
344+
{{< /note >}}
345+
341346
Use the configuration options shown in the example below to enable SCH
342347
during the connection:
343348

content/develop/clients/redis-py/connect.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,11 @@ lets a client take action to avoid disruptions in service.
262262
See [Smart client handoffs]({{< relref "/develop/clients/sch" >}})
263263
for more information about SCH.
264264

265+
{{< note >}}Using SCH with redis-py requires v7.0.0 or later for
266+
basic connections, and v7.2.0 or later for
267+
[OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}) connections.
268+
{{< /note >}}
269+
265270
By default, `redis-py` always attempts to connect via SCH but falls back to
266271
a non-SCH connection if the server doesn't support it. However, you can configure SCH
267272
explicitly by passing a `MaintNotificationsConfig` object during the connection,

content/develop/clients/sch.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,17 @@ if you select the [RESP3]({{< relref "/develop/reference/protocol-spec#resp-vers
5959
protocol, which is a requirement for SCH. However, you can
6060
configure some parameters, such as the timeouts to use
6161
during maintenance.
62-
See the pages linked below to learn how to configure SCH for:
6362

64-
- [redis-py]({{< relref "/develop/clients/redis-py/connect#connect-using-smart-client-handoffs-sch" >}})
65-
- [node-redis]({{< relref "/develop/clients/nodejs/connect#connect-using-smart-client-handoffs-sch" >}})
66-
- [Lettuce]({{< relref "/develop/clients/lettuce/connect#connect-using-smart-client-handoffs-sch" >}})
67-
- [go-redis]({{< relref "/develop/clients/go/connect#connect-using-smart-client-handoffs-sch" >}})
63+
The table below lists the Redis client libraries that support SCH,
64+
and the versions that added support for basic connections and
65+
[OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}) connections.
66+
67+
| Client | Basic connection | OSS Cluster API |
68+
| :-- | :-- | :-- |
69+
| [redis-py]({{< relref "/develop/clients/redis-py/connect#connect-using-smart-client-handoffs-sch" >}}) | v7.0.0 | v7.2.0 |
70+
| [node-redis]({{< relref "/develop/clients/nodejs/connect#connect-using-smart-client-handoffs-sch" >}}) | v5.9.0 | v5.11.0 |
71+
| [Lettuce]({{< relref "/develop/clients/lettuce/connect#connect-using-smart-client-handoffs-sch" >}}) | v7.0.0 | - |
72+
| [go-redis]({{< relref "/develop/clients/go/connect#connect-using-smart-client-handoffs-sch" >}}) | v9.16.0 | v9.18.0 |
6873

6974
## SCH support in Redis server products
7075

0 commit comments

Comments
 (0)