sunsubscribe.3valkey - Man Page

Stops listening to messages posted to shard channels.

Synopsis

SUNSUBSCRIBE shardchannel [shardchannel...]

Description

Unsubscribes the client from the given shard channels, or from all of them if none is given.

When no shard channels are specified, the client is unsubscribed from all the previously subscribed shard channels. In this case a message for every unsubscribed shard channel will be sent to the client.

Note: The global channels and shard channels needs to be unsubscribed from separately.

For more information about sharded Pub/Sub, see valkey-pubsub(7) Sharded Pub/Sub.

Reply

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

Complexity

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

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), subscribe(3valkey), unsubscribe(3valkey)

Info

2024-09-23 8.0.0 Valkey Command Manual