summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/ssubscribe.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/ssubscribe.md')
-rw-r--r--iredis/data/commands/ssubscribe.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/iredis/data/commands/ssubscribe.md b/iredis/data/commands/ssubscribe.md
new file mode 100644
index 0000000..bf7d30e
--- /dev/null
+++ b/iredis/data/commands/ssubscribe.md
@@ -0,0 +1,21 @@
+Subscribes the client to the specified shard channels.
+
+In a Redis cluster, shard channels are assigned to slots by the same algorithm used to assign keys to slots.
+Client(s) can subscribe to a node covering a slot (primary/replica) to receive the messages published.
+All the specified shard channels needs to belong to a single slot to subscribe in a given `SSUBSCRIBE` call,
+A client can subscribe to channels across different slots over separate `SSUBSCRIBE` call.
+
+For more information about sharded Pub/Sub, see [Sharded Pub/Sub](/topics/pubsub#sharded-pubsub).
+
+@examples
+
+```
+> ssubscribe orders
+Reading messages... (press Ctrl-C to quit)
+1) "ssubscribe"
+2) "orders"
+3) (integer) 1
+1) "smessage"
+2) "orders"
+3) "hello"
+```