XGROUP DESTROY

Syntax
XGROUP DESTROY key group
Available since:
Redis Open Source 5.0.0
Time complexity:
O(N) where N is the number of entries in the group's pending entries list (PEL).
ACL categories:
@write, @stream, @slow,
Compatibility:
Redis Enterprise and Redis Cloud compatibility

The XGROUP DESTROY command completely destroys a consumer group.

The consumer group will be destroyed even if there are active consumers, and pending messages, so make sure to call this command only when really needed.

Redis Enterprise and Redis Cloud compatibility

Redis
Enterprise		 Redis
Cloud		 Notes
✅ Standard
✅ Active-Active		 ✅ Standard
✅ Active-Active

Return information

Integer reply: the number of destroyed consumer groups, either 0 or 1.
RATE THIS PAGE
Back to top ↑