XGROUP - Upstash Documentation

Arguments

keybodystringrequired

The key of the stream.

subcommandbodyobjectrequired

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

typebody'CREATE'required

Create a new consumer group.

groupbodystringrequired

The consumer group name.

idbodystring | '$'required

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

optionsbody

MKSTREAMbodyboolean

Create the stream if it doesn't exist.

ENTRIESREADbodynumber

Set the number of entries read by the group.

typebody'CREATECONSUMER'required

Create a new consumer in the group.

groupbodystringrequired

The consumer group name.

consumerbodystringrequired

The consumer name to create.

typebody'DELCONSUMER'required

Delete a consumer from the group.

groupbodystringrequired

The consumer group name.

consumerbodystringrequired

The consumer name to delete.

typebody'DESTROY'required

Delete the entire consumer group.

groupbodystringrequired

The consumer group name to destroy.

typebody'SETID'required

Set the last delivered ID for the group.

groupbodystringrequired

The consumer group name.

idbodystring | '$'required

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

optionsbody

ENTRIESREADbodynumber

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

Create group

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

Create consumer

const result = await redis.xgroup("mystream", {  type: "CREATECONSUMER",  group: "mygroup",  consumer: "consumer1"});

Delete consumer

const result = await redis.xgroup("mystream", {  type: "DELCONSUMER",   group: "mygroup",  consumer: "consumer1"});

Set group ID

const result = await redis.xgroup("mystream", {  type: "SETID",  group: "mygroup",   id: "0-0"});

Destroy group

const result = await redis.xgroup("mystream", {  type: "DESTROY",  group: "mygroup"});