File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -136,6 +136,11 @@ lets a client take action to avoid disruptions in service.
136136See [ Smart client handoffs] ({{< relref "/develop/clients/sch" >}})
137137for 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+
139144By default, ` go-redis ` always attempts to connect via SCH but falls back to
140145a non-SCH connection if the server doesn't support it. However, you can configure SCH
141146explicitly by passing a ` MaintNotificationsConfig ` object during the connection,
Original file line number Diff line number Diff line change @@ -264,6 +264,9 @@ lets a client take action to avoid disruptions in service.
264264See [ Smart client handoffs] ({{< relref "/develop/clients/sch" >}})
265265for more information about SCH.
266266
267+ {{< note >}}Support for SCH in Lettuce requires v7.0.0 or later.
268+ {{< /note >}}
269+
267270By default, ` Lettuce ` always attempts to connect via SCH but falls back to
268271a non-SCH connection if the server doesn't support it. However, you can configure SCH
269272explicitly by creating a ` MaintNotificationsConfig ` object and/or a ` TimeoutOptions `
Original file line number Diff line number Diff line change @@ -338,6 +338,11 @@ lets a client take action to avoid disruptions in service.
338338See [ Smart client handoffs] ({{< relref "/develop/clients/sch" >}})
339339for 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+
341346Use the configuration options shown in the example below to enable SCH
342347during the connection:
343348
Original file line number Diff line number Diff line change @@ -262,6 +262,11 @@ lets a client take action to avoid disruptions in service.
262262See [ Smart client handoffs] ({{< relref "/develop/clients/sch" >}})
263263for 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+
265270By default, ` redis-py ` always attempts to connect via SCH but falls back to
266271a non-SCH connection if the server doesn't support it. However, you can configure SCH
267272explicitly by passing a ` MaintNotificationsConfig ` object during the connection,
Original file line number Diff line number Diff line change @@ -59,12 +59,17 @@ if you select the [RESP3]({{< relref "/develop/reference/protocol-spec#resp-vers
5959protocol, which is a requirement for SCH. However, you can
6060configure some parameters, such as the timeouts to use
6161during 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
You can’t perform that action at this time.
0 commit comments