XGROUP CREATECONSUMER

Syntax text Syntax diagram API methods

XGROUP CREATECONSUMER key group consumer

Client:

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

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

xgroupCreateConsumer(
    key: byte[],
    groupName: byte[],
    consumerName: byte[]
) → boolean

xgroupCreateConsumer(
    key: String,
    groupName: String,
    consumerName: String
) → boolean

xgroupCreateConsumer(
    key: String,
    groupName: String,
    consumerName: String
) → boolean

xgroupCreateconsumer(
    key: K,  // the stream key.
    consumer: Consumer<K>  // consumer identified by group name and consumer key.
) → Boolean  // simple-reply true if successful. @since 6.1

xgroupCreateconsumer(
    key: K,  // the stream key.
    consumer: Consumer<K>  // consumer identified by group name and consumer key.
) → RedisFuture<Boolean>  // simple-reply true if successful. @since 6.1

xgroupCreateconsumer(
    key: K,  // the stream key.
    consumer: Consumer<K>  // consumer identified by group name and consumer key.
) → Mono<Boolean>  // simple-reply true if successful. @since 6.1

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

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

xgroup_createconsumer(
    key: K,
    group: G,
    consumer: C
) → bool

xgroup_createconsumer(
    key: K,
    group: G,
    consumer: C
) → bool

Available since:: Redis Open Source 6.2.0
Time complexity:: O(1)
ACL categories:: @write, @stream, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Create a consumer named consumername in the consumer group groupname of the stream that's stored at key.

Consumers are also created automatically whenever an operation, such as XREADGROUP, references a consumer that doesn't exist. This is valid for XREADGROUP only when there is data in the stream.

Required arguments

key

The stream key.

group

The consumer group name.

consumer

The name of the consumer to create.

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 created consumers, either 0 or 1.