XGROUP - Upstash Documentation

Arguments

key

string

required

The key of the stream.

subcommand

object

required

The XGROUP subcommand and its parameters. Can be one of:

Show CREATE

type

'CREATE'

required

Create a new consumer group.

group

string

required

The consumer group name.

string | '$'

required

The stream entry ID to start consuming from. Use ’$’ to start from the end.

options

Show options

MKSTREAM

boolean

Create the stream if it doesn’t exist.

ENTRIESREAD

number

Set the number of entries read by the group.

Show CREATECONSUMER

type

'CREATECONSUMER'

required

Create a new consumer in the group.

group

string

required

The consumer group name.

consumer

string

required

The consumer name to create.

Show DELCONSUMER

type

'DELCONSUMER'

required

Delete a consumer from the group.

group

string

required

The consumer group name.

consumer

string

required

The consumer name to delete.

Show DESTROY

type

'DESTROY'

required

Delete the entire consumer group.

group

string

required

The consumer group name to destroy.

Show SETID

type

'SETID'

required

Set the last delivered ID for the group.

group

string

required

The consumer group name.

string | '$'

required

The stream entry ID to set as the last delivered ID.

options

Show options

ENTRIESREAD

number

Set the number of entries read by the group.

Response

The return type depends on the subcommand:

CREATE: Returns “OK” string
CREATECONSUMER: Returns 1 if created, 0 if already exists
DELCONSUMER: Returns the number of pending messages the consumer had
DESTROY: Returns 1 if destroyed, 0 if group didn’t exist
SETID: Returns “OK” string

const result = await redis.xgroup("mystream", {
  type: "CREATE",
  group: "mygroup",
  id: "$",
  options: { MKSTREAM: true }
});

Redis

​Arguments

​Response

Arguments

Response