Skip to content

Commit 5e049f9

Browse files
DOC-5711 remove endpoint type details
1 parent 254b6cb commit 5e049f9

File tree

2 files changed

+8
-23
lines changed

2 files changed

+8
-23
lines changed

content/develop/clients/nodejs/connect.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,6 @@ during the connection:
345345
const client = createClient({
346346
RESP: 3,
347347
maintPushNotifications: 'auto',
348-
maintMovingEndpointType: 'auto',
349348
maintRelaxedCommandTimeout: 10000,
350349
maintRelaxedSocketTimeout: 10000,
351350
...
@@ -362,23 +361,11 @@ The available options are:
362361
- `'disabled'`: don't use SCE
363362
- `'enabled'`: attempt to activate SCE on the server and abort the connection if it isn't supported
364363
- `'auto'`: attempt to activate SCE on the server and fall back to a non-SCE
365-
connection if it isn't supported. This is the default.
366-
- `maintRelaxedCommandTimeout`: (`number`) The command timeout to use when the server is
367-
in maintenance mode. The default is 10000 (10 seconds). If a timeout happens during the
368-
maintenance period, the client receives a `CommandTimeoutDuringMaintenance` error.
369-
- `maintRelaxedSocketTimeout`: (`number`) The socket timeout to use when the server is in
370-
maintenance mode. The default is 10000 (10 seconds). If a timeout happens during the
371-
maintenance period, the client receives a `SocketTimeoutDuringMaintenance` error.
372-
- `maintMovingEndpointType`: (`MovingEndpointType`) Controls how the client requests the
373-
endpoint to reconnect to. The options are:
374-
- `internal-ip`: Enforce requesting the internal IP.
375-
- `internal-fqdn`: Enforce requesting the internal FQDN.
376-
- `external-ip`: Enforce requesting the external IP address.
377-
- `external-fqdn`: Enforce requesting the external FQDN.
378-
- `none`: Used to request a null endpoint, which tells the client to reconnect
379-
based on its current config.
380-
- `auto`: Let the client decide based on its current config. This is the default.
381-
364+
connection if it isn't supported. This is the default.
365+
- `maintRelaxedCommandTimeout`: (`number`) The command timeout to use while the server is
366+
performing maintenance. The default is 10000 (10 seconds). If a timeout happens during the maintenance period, the client receives a `CommandTimeoutDuringMaintenance` error.
367+
- `maintRelaxedSocketTimeout`: (`number`) The socket timeout to use while the server is
368+
performing maintenance. The default is 10000 (10 seconds). If a timeout happens during the maintenance period, the client receives a `SocketTimeoutDuringMaintenance` error.
382369

383370
## Connection events
384371

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,7 @@ r = redis.Redis(
276276
maintenance_events_config= MaintenanceEventsConfig(
277277
enabled=True,
278278
proactive_reconnect=True,
279-
relax_timeout=30,
280-
endpoint_type=EndpointType.INTERNAL_IP,
279+
relax_timeout=10,
281280
),
282281
...
283282
)
@@ -292,6 +291,5 @@ The `MaintenanceEventsConfig` constructor accepts the following parameters:
292291
| Name | Type | Default | Description |
293292
|------|------|---------|-------------|
294293
| `enabled` | `bool` | `False` | Whether or not to enable SCE. |
295-
| `proactive_reconnect` | `bool` | `False` | Whether or not to automatically reconnect when a node is replaced. |
296-
| `relax_timeout` | `int` | `20` | The number of seconds to wait before reconnecting after a node replacement. A value of `-1` disables the relax timeout. |
297-
| `endpoint_type` | `EndpointType` | `None` | Override for the endpoint type to use in the `CLIENT MAINT_NOTIFICATIONS` command. If this is `None`, the endpoint type will be determined automatically based on the host and TLS configuration. |
294+
| `proactive_reconnect` | `bool` | `True` | Whether or not to automatically reconnect when a node is replaced. |
295+
| `relax_timeout` | `int` | `20` | The timeout (in seconds) to use while the server is performing maintenance. A value of `-1` disables the relax timeout and just uses the normal timeout during maintenance. |

0 commit comments

Comments
 (0)