Skip to content

docs: add maintNotificationsConfig to ClientOptions documentation #3487

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

Open
Parent: 7.0.x
wants to merge 2 commits into
base: 7.0.x
Choose a base branch
from
+23 −0
Open

docs: add maintNotificationsConfig to ClientOptions documentation #3487

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c208ff7
docs: add maintNotificationsConfig to ClientOptions documentation
ggivo Oct 23, 2025
2325f49
move relaxedTimeouts config doc under maintConfig section
ggivo Oct 23, 2025
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
23 changes: 23 additions & 0 deletions docs/advanced-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,29 @@ queued commands.</p>
refuse commands and cancel these with an exception.</p></td>
</tr>
<tr>
<td>Maintenance Notifications</td>
<td><code>maintNotificationsConfig</code></td>
<td><code>enabled()</code></td>
</tr>
<tr>
<td colspan="3"><p>Since: 7.0</p>
<p>Enables Seamless Connection Handover (SCH) by listening for
server-side maintenance event notifications. When enabled, the client
receives push notifications about maintenance operations and can
proactively reconnect to healthy nodes, reducing failed commands during
maintenance windows.</p>
<p>Configure endpoint type for reconnection using
<code>MaintNotificationsConfig.enabled(EndpointType.EXTERNAL_IP)</code>
or use <code>MaintNotificationsConfig.enabled()</code> for
auto-detection based on connection characteristics. Disable with
<code>MaintNotificationsConfig.disabled()</code>.</p>
<p>Use <code>TimeoutOptions.relaxedTimeoutsDuringMaintenance(Duration)</code>
to set extended timeout during maintenance operations (default: 10
seconds).</p>
<p>This feature requires Redis Enterprise or a Redis server that
supports maintenance event notifications.</p></td>
</tr>
<tr>
<td>Replay filter</td>
<td><code>replayFilter</code></td>
<td><code>(cmd) -> false</code></td>
Expand Down