DEV: add info. about sub-keyspace notifications#3014
Open
dwdougherty wants to merge 2 commits intoDOC-6334from
Open
DEV: add info. about sub-keyspace notifications#3014dwdougherty wants to merge 2 commits intoDOC-6334from
dwdougherty wants to merge 2 commits intoDOC-6334from
Conversation
Contributor
Contributor
🛡️ Jit Security Scan Results
✅ No security findings were detected in this PR
Security scan by Jit
|
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 10, 2026
LiorKogan
reviewed
Apr 11, 2026
|
|
||
| | Command | Event | Subkeys included | | ||
| |---|---|---| | ||
| | [`HSET`]({{< relref "/commands/hset" >}}) / [`HMSET`]({{< relref "/commands/hmset" >}}) | `hset` | All subkeys being set | |
Member
There was a problem hiding this comment.
In all rows of this table:
subkey --> field
Because all these rows are specific Hash events.
The title should remain "subkeys".
LiorKogan
reviewed
Apr 11, 2026
|
|
||
| $ redis-cli config set notify-keyspace-events STIV | ||
|
|
||
| ### Supported commands |
Member
There was a problem hiding this comment.
"Supported commands" is probably not a good title.
Maybe "Commands emitting subkey notifications"?
LiorKogan
reviewed
Apr 11, 2026
| S Subkeyspace events, published with __subkeyspace@<db>__ prefix. | ||
| T Subkeyevent events, published with __subkeyevent@<db>__ prefix. | ||
| I Subkeyspaceitem events, published with __subkeyspaceitem@<db>__ prefix. | ||
| V Subkeyspaceevent events, published with __subkeyspaceevent@<db>__ prefix. |
Member
There was a problem hiding this comment.
Based on Debing's reply on Slack, we should add h as well.
IIUC, specifying h wouldn't change much, as this is the only key type supported now.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Redis 8.8 feature
Note
Low Risk
Low risk documentation-only change that adds a new page describing Pub/Sub subkey notification channels and configuration; no product code is modified.
Overview
Adds new documentation page
develop/pubsub/subkeyspace-notifications.mddescribing Redis 8.8 subkey notifications (per-field/path/element events) as an extension to keyspace notifications.Covers the four new Pub/Sub channel formats and payload encodings, configuration via new
notify-keyspace-eventsflags (S,T,I,V), supported hash commands/events, and a shortredis-cliexample for observing notifications.Reviewed by Cursor Bugbot for commit 4bf47b2. Bugbot is set up for automated code reviews on this repo. Configure here.