Upstash Documentation

XREADGROUP

Reads data from a stream as part of a consumer group.
1 min read

Arguments#

groupstringrequired#

The consumer group name.

consumerstringrequired#

The consumer name within the group.

keystring | string[]required#

The stream key(s) to read from. Can be a single stream key or an array of stream keys for multiple streams.

idsstring | string[]required#

The starting ID(s) to read from. Use ">" to read messages never delivered to any consumer in the group. For multiple streams, provide an array of IDs corresponding to each stream.

options#
Show properties
countnumber#

The maximum number of messages to return per stream.

NOACKboolean#

Don't add messages to the pending entries list (messages won't need acknowledgment).

Response#