summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/xgroup-delconsumer.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/xgroup-delconsumer.md')
-rw-r--r--iredis/data/commands/xgroup-delconsumer.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/iredis/data/commands/xgroup-delconsumer.md b/iredis/data/commands/xgroup-delconsumer.md
new file mode 100644
index 0000000..9e73da8
--- /dev/null
+++ b/iredis/data/commands/xgroup-delconsumer.md
@@ -0,0 +1,10 @@
+The `XGROUP DELCONSUMER` command deletes a consumer from the consumer group.
+
+Sometimes it may be useful to remove old consumers since they are no longer used.
+
+Note, however, that any pending messages that the consumer had will become unclaimable after it was deleted.
+It is strongly recommended, therefore, that any pending messages are claimed or acknowledged prior to deleting the consumer from the group.
+
+@return
+
+@integer-reply: the number of pending messages that the consumer had before it was deleted