subscribe.3valkey - Man Page

Listens for messages published to channels.

Synopsis

SUBSCRIBE channel [channel...]

Description

Subscribes the client to the specified channels.

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.

Note that RESET can be called to exit subscribed state.

For more information, see valkey-pubsub(7) Pub/sub.

Reply

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

Complexity

O(N) where N is the number of channels to subscribe to.

Acl Categories

@pubsub @slow

History

See Also

psubscribe(3valkey), publish(3valkey), pubsub(3valkey), pubsub-channels(3valkey), pubsub-help(3valkey), pubsub-numpat(3valkey), pubsub-numsub(3valkey), pubsub-shardchannels(3valkey), pubsub-shardnumsub(3valkey), punsubscribe(3valkey), spublish(3valkey), ssubscribe(3valkey), sunsubscribe(3valkey), unsubscribe(3valkey)

Info

2024-09-23 8.0.0 Valkey Command Manual