XGROUP DELCONSUMER
Syntax
XGROUP DELCONSUMER key group consumer
- Available since:
- Redis Open Source 5.0.0
- Time complexity:
- O(1)
- ACL categories:
-
@write,@stream,@slow, - Compatibility:
- Redis Enterprise and Redis Cloud compatibility
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.
Redis Enterprise and Redis Cloud compatibility
| Redis Enterprise |
Redis Cloud |
Notes |
|---|---|---|
| ✅ Standard |
✅ Standard |
Return information
Integer reply: the number of pending messages the consumer had before it was deleted.