Tools

Get Redis

Downloads

Resources

Connect

Learn

Latest

See how it works

Visit Demo Center

Docs Pricing

Login Book a meeting Try Redis

PSUBSCRIBE

Syntax

PSUBSCRIBE pattern [pattern ...]

Available since:: Redis Open Source 2.0.0
Time complexity:: O(N) where N is the number of patterns to subscribe to.
ACL categories:: @pubsub, @slow,
Compatibility:: Redis Enterprise and Redis Cloud compatibility

Subscribes the client to the given patterns.

Supported glob-style patterns:

h?llo subscribes to hello, hallo and hxllo
h*llo subscribes to hllo and heeeello
h[ae]llo subscribes to hello and hallo, but not hillo

Use \ to escape special characters if you want to match them verbatim.

Once the client enters the subscribed state it is not supposed to issue any other commands, except for additional SUBSCRIBE, SSUBSCRIBE, PSUBSCRIBE, UNSUBSCRIBE, SUNSUBSCRIBE, PUNSUBSCRIBE, PING, RESET and QUIT commands. However, if RESP3 is used (see HELLO) it is possible for a client to issue any commands while in subscribed state.

For more information, see Pub/sub.

Behavior change history

>= 6.2.0: RESET can be called to exit subscribed state.

Redis Enterprise and Redis Cloud compatibility

Redis Enterprise	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

When successful, this command doesn't return anything. Instead, for each pattern, one message with the first element being the string psubscribe is pushed as a confirmation that the command succeeded.