XGROUP CREATE

Syntax text Syntax diagram API methods

XGROUP CREATE key group <id | $> [MKSTREAM]
  [ENTRIESREAD entries-read]

Client:

xgroup_create(
    name: KeyT,
    groupname: GroupT,
    id: StreamIdT = "$",
    mkstream: bool = False,
    entries_read: Optional[int] = None
) → ResponseT

XGROUP_CREATE(
    key: RedisArgument,
    group: RedisArgument,
    id: RedisArgument,
    options?: XGroupCreateOptions
) → Any

xgroupCreate(
    key: byte[],
    consumer: byte[],
    id: byte[],
    makeStream: boolean
) → String

xgroupCreate(
    key: String,
    groupName: String,
    makeStream: StreamEntryID id final boolean
) → String

xgroupCreate(
    key: String,
    groupName: String,
    id: StreamEntryID,
    makeStream: boolean
) → String

xgroupCreate(
    streamOffset: StreamOffset<K>,  // name of the stream containing the offset to set.
    group: K  // name of the consumer group.
) → String  // simple-reply true if successful. @since 5.2

xgroupCreate(
    streamOffset: StreamOffset<K>,  // name of the stream containing the offset to set.
    group: K,  // name of the consumer group.
    args: XGroupCreateArgs
) → String  // simple-reply true if successful. @since 5.2

xgroupCreate(
    streamOffset: StreamOffset<K>,  // name of the stream containing the offset to set.
    group: K  // name of the consumer group.
) → RedisFuture<String>  // simple-reply true if successful. @since 5.2

xgroupCreate(
    streamOffset: StreamOffset<K>,  // name of the stream containing the offset to set.
    group: K,  // name of the consumer group.
    args: XGroupCreateArgs
) → RedisFuture<String>  // simple-reply true if successful. @since 5.2

xgroupCreate(
    streamOffset: StreamOffset<K>,  // name of the stream containing the offset to set.
    group: K  // name of the consumer group.
) → Mono<String>  // simple-reply true if successful. @since 5.2

xgroupCreate(
    streamOffset: StreamOffset<K>,  // name of the stream containing the offset to set.
    group: K,  // name of the consumer group.
    args: XGroupCreateArgs
) → Mono<String>  // simple-reply true if successful. @since 5.2

XGroupCreate(
    ctx: context.Context,
    stream: Any,
    group: Any,
    start: string
) → *StatusCmd

XGroupCreateMkStream(
    ctx: context.Context,
    stream: Any,
    group: Any,
    start: string
) → *StatusCmd

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    createStream: bool,  // Create the stream if it does not already exist.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    createStream: bool,  // Create the stream if it does not already exist.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    createStream: bool,  // Create the stream if it does not already exist.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

StreamCreateConsumerGroup(
    key: RedisKey,  // The key of the stream.
    groupName: RedisValue,  // The name of the group to create.
    position: RedisValue?,  // The position to begin reading the stream. Defaults to NewMessages.
    createStream: bool,  // Create the stream if it does not already exist.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the group was created, false otherwise.

create(
    $key: string,
    $group: string,
    $id: string,
    bool $mkStream = false: Any,
    ?string $entriesRead = null: Any
) → Status

xgroup_create(
    key: K,
    group: G,
    id: ID
) → ()

xgroup_create_mkstream(
    key: K,
    group: G,
    id: ID
) → ()

xgroup_create(
    key: K,
    group: G,
    id: ID
) → ()

xgroup_create_mkstream(
    key: K,
    group: G,
    id: ID
) → ()

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

Create a new consumer group uniquely identified by groupname for the stream stored at key

Every group has a unique name in a given stream. When a consumer group with the same name already exists, the command returns a -BUSYGROUP error.

The command's id argument specifies the last delivered entry in the stream from the new group's perspective. The special ID $ is the ID of the last entry in the stream, but you can substitute it with any valid ID.

For example, if you want the group's consumers to fetch the entire stream from the beginning, use zero as the starting ID for the consumer group:

XGROUP CREATE mystream mygroup 0

By default, the XGROUP CREATE command expects that the target stream exists, and returns an error when it doesn't. If a stream does not exist, you can create it automatically with length of 0 by using the optional MKSTREAM subcommand as the last argument after the id:

XGROUP CREATE mystream mygroup $ MKSTREAM

To enable consumer group lag tracking, specify the optional entries_read named argument with an arbitrary ID. An arbitrary ID is any ID that isn't the ID of the stream's first entry, last entry, or zero ("0-0") ID. Use it to find out how many entries are between the arbitrary ID (excluding it) and the stream's last entry. Set the entries_read the stream's entries_added subtracted by the number of entries.

Required arguments

key

The stream key.

group

The name of the consumer group to create.

id | $

The ID of the last delivered message the group starts reading after. Use $ for the last message currently in the stream, or 0 to read from the start.

Optional arguments

MKSTREAM

Create the stream as an empty stream if it does not already exist.

ENTRIESREAD entries-read

Set the group's initial entries-read counter, used to compute its lag.

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Simple string reply: OK.

History

Starting with Redis version 7.0.0: Added the entries_read named argument.