xgroup-destroy.3valkey - Man Page

Destroys a consumer group.

Synopsis

XGROUP DESTROY key group

Description

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.

Reply

valkey-protocol(7) Integer reply: the number of destroyed consumer groups, either 0 or 1.

Complexity

O(N) where N is the number of entries in the group’s pending entries list (PEL).

Acl Categories

@slow @stream @write

History

See Also

xack(3valkey), xadd(3valkey), xautoclaim(3valkey), xclaim(3valkey), xdel(3valkey), xgroup(3valkey), xgroup-create(3valkey), xgroup-createconsumer(3valkey), xgroup-delconsumer(3valkey), xgroup-help(3valkey), xgroup-setid(3valkey), xinfo(3valkey), xinfo-consumers(3valkey), xinfo-groups(3valkey), xinfo-help(3valkey), xinfo-stream(3valkey), xlen(3valkey), xpending(3valkey), xrange(3valkey), xread(3valkey), xreadgroup(3valkey), xrevrange(3valkey), xsetid(3valkey), xtrim(3valkey)

Info

2024-09-23 8.0.0 Valkey Command Manual