summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/pubsub-shardchannels.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/pubsub-shardchannels.md')
-rw-r--r--iredis/data/commands/pubsub-shardchannels.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/iredis/data/commands/pubsub-shardchannels.md b/iredis/data/commands/pubsub-shardchannels.md
new file mode 100644
index 0000000..543eab0
--- /dev/null
+++ b/iredis/data/commands/pubsub-shardchannels.md
@@ -0,0 +1,20 @@
+Lists the currently *active shard channels*.
+
+An active shard channel is a Pub/Sub shard channel with one or more subscribers.
+
+If no `pattern` is specified, all the channels are listed, otherwise if pattern is specified only channels matching the specified glob-style pattern are listed.
+
+The information returned about the active shard channels are at the shard level and not at the cluster level.
+
+@return
+
+@array-reply: a list of active channels, optionally matching the specified pattern.
+
+@examples
+
+```
+> PUBSUB SHARDCHANNELS
+1) "orders"
+PUBSUB SHARDCHANNELS o*
+1) "orders"
+```