XGROUP DELCONSUMER

Syntax text Syntax diagram API methods

XGROUP DELCONSUMER key group consumer

Client:

xgroup_delconsumer(
    name: KeyT,
    groupname: GroupT,
    consumername: ConsumerT
) → ResponseT

XGROUP_DELCONSUMER(
    key: RedisArgument,
    group: RedisArgument,
    consumer: RedisArgument
) → Any

xgroupDelConsumer(
    key: byte[],
    groupName: byte[],
    consumerName: byte[]
) → long

xgroupDelConsumer(
    key: String,
    groupName: String,
    consumerName: String
) → long

xgroupDelConsumer(
    key: String,
    groupName: String,
    consumerName: String
) → long

xgroupDelconsumer(
    key: K,  // the stream key.
    consumer: Consumer<K>  // consumer identified by group name and consumer key.
) → Long  // Long integer-reply number of pending messages.

xgroupDelconsumer(
    key: K,  // the stream key.
    consumer: Consumer<K>  // consumer identified by group name and consumer key.
) → RedisFuture<Long>  // Long integer-reply number of pending messages.

xgroupDelconsumer(
    key: K,  // the stream key.
    consumer: Consumer<K>  // consumer identified by group name and consumer key.
) → Mono<Long>  // Long integer-reply number of pending messages.

XGroupDelConsumer(
    ctx: context.Context,
    stream: Any,
    group: Any,
    consumer: string
) → *IntCmd

StreamDeleteConsumer(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the consumer group.
    consumerName: RedisValue,  // The name of the consumer.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of messages that were pending for the deleted consumer.

StreamDeleteConsumer(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the consumer group.
    consumerName: RedisValue,  // The name of the consumer.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of messages that were pending for the deleted consumer.

StreamDeleteConsumer(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the consumer group.
    consumerName: RedisValue,  // The name of the consumer.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of messages that were pending for the deleted consumer.

StreamDeleteConsumer(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the consumer group.
    consumerName: RedisValue,  // The name of the consumer.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of messages that were pending for the deleted consumer.

delConsumer(
    $key: string,
    $group: string,
    $consumer: string
) → int

xgroup_delconsumer(
    key: K,
    group: G,
    consumer: C
) → usize

xgroup_delconsumer(
    key: K,
    group: G,
    consumer: C
) → usize

Available since:: Redis Open Source 5.0.0
Time complexity:: O(1)
ACL categories:: @write, @stream, @slow,
Compatibility:: Redis Software 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.

Required arguments

key

The stream key.

group

The consumer group name.

consumer

The name of the consumer to delete.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Integer reply: the number of pending messages the consumer had before it was deleted.