XREADGROUP for consumer groups in Redis

Introduction

XREADGROUP helps multiple consumers share the work of reading messages from a Redis stream without missing or repeating messages.

When you want several workers to process messages from the same stream without overlap.

When you need to ensure each message is processed at least once by one consumer.

When you want to track which messages have been delivered but not yet acknowledged.

When you want to balance load among consumers reading from a stream.

When you want to recover unacknowledged messages for retry.

Syntax

Redis

XREADGROUP GROUP <groupname> <consumername> [COUNT <count>] [BLOCK <milliseconds>] STREAMS <key> <id>

Use '>' as the to read new messages never delivered to any consumer in the group.

COUNT limits how many messages to return; BLOCK waits for new messages if none are available.

Examples

Read new messages from 'mystream' for consumer 'Alice' in group 'mygroup'.

Redis

XREADGROUP GROUP mygroup Alice STREAMS mystream >

Read up to 5 new messages for consumer 'Bob' in group 'mygroup'.

Redis

XREADGROUP GROUP mygroup Bob COUNT 5 STREAMS mystream >

Wait up to 1000 milliseconds for new messages for 'Alice' before returning.

Redis

XREADGROUP GROUP mygroup Alice BLOCK 1000 STREAMS mystream >

Sample Program

Create a group 'mygroup' on 'mystream' starting at the beginning, add a message with field 'name' and value 'Alice', then read new messages for consumer 'Alice'.

Redis

XGROUP CREATE mystream mygroup 0
XADD mystream * name Alice
XREADGROUP GROUP mygroup Alice STREAMS mystream >

Important Notes

You must create the consumer group with XGROUP CREATE before using XREADGROUP.

Use '>' as the ID to get only new messages never delivered to any consumer in the group.

Remember to acknowledge messages with XACK after processing to avoid redelivery.

Summary

XREADGROUP lets multiple consumers share reading from a Redis stream safely.

Use consumer groups to balance work and track message processing.

Always create the group first and acknowledge messages after processing.

Practice

1. What is the main purpose of using XREADGROUP in Redis streams?

easy

A. To backup the stream data to disk

B. To delete messages from the stream automatically

C. To create a new stream in Redis

D. To allow multiple consumers to read from the same stream without missing messages

Solution

1. Step 1: Understand consumer groups in Redis streams

   Consumer groups allow multiple consumers to share the workload of reading messages from a stream safely.

2. Step 2: Role of XREADGROUP command

   XREADGROUP reads messages for a specific consumer group, ensuring messages are distributed and not missed.

3. Final Answer:

   To allow multiple consumers to read from the same stream without missing messages -> Option D

4. Quick Check:

   Purpose of XREADGROUP = safe multi-consumer reading [OK]

Hint: XREADGROUP is for sharing stream reads among consumers [OK]

Common Mistakes:

• Thinking XREADGROUP deletes messages
• Confusing XREADGROUP with stream creation
• Assuming it backs up data automatically

2. Which of the following is the correct syntax to read messages from a consumer group using XREADGROUP?

easy

A. XREADGROUP GROUP consumername groupname STREAMS mystream >

B. XREADGROUP STREAMS mystream GROUP groupname consumername >

C. XREADGROUP GROUP groupname consumername STREAMS mystream >

D. XREADGROUP STREAMS > mystream GROUP groupname consumername

Solution

1. Step 1: Recall the correct order of XREADGROUP syntax

   The correct syntax is: XREADGROUP GROUP <groupname> <consumername> STREAMS <stream> <id>

2. Step 2: Match options with syntax

   XREADGROUP GROUP groupname consumername STREAMS mystream > matches the correct order and keywords exactly.

3. Final Answer:

   XREADGROUP GROUP groupname consumername STREAMS mystream > -> Option C

4. Quick Check:

   Syntax order = GROUP then consumer then STREAMS [OK]

Hint: GROUP keyword comes right after XREADGROUP [OK]

Common Mistakes:

• Swapping groupname and consumername order
• Placing STREAMS before GROUP
• Misplacing the '>' symbol

3. Given a Redis stream mystream with messages and a consumer group group1, what will be the output of this command?

XREADGROUP GROUP group1 consumer1 STREAMS mystream 0

medium

A. An error because 0 is invalid ID

B. All pending and new messages from the stream for consumer1

C. Only new messages added after the command runs

D. No messages because 0 means no messages

Solution

1. Step 1: Understand the meaning of ID '0' in XREADGROUP

   Using '0' as the ID means the consumer wants to read all pending messages (not yet acknowledged) plus new messages.

2. Step 2: Effect on output

   The command returns all pending messages for consumer1 and any new messages added after the command runs.

3. Final Answer:

   All pending and new messages from the stream for consumer1 -> Option B

4. Quick Check:

   ID '0' = pending + new messages [OK]

Hint: ID '0' fetches pending plus new messages [OK]

Common Mistakes:

• Thinking '0' causes error
• Assuming only new messages are returned
• Believing '0' means no messages

4. You run this command but get an error:

XREADGROUP GROUP group1 consumer1 STREAMS mystream >

What is the likely cause?

medium

A. The consumer group 'group1' does not exist

B. The stream 'mystream' is empty

C. The consumer name 'consumer1' is invalid

D. The '>' symbol is misplaced

Solution

1. Step 1: Check prerequisites for XREADGROUP

   XREADGROUP requires the consumer group to exist before reading messages.

2. Step 2: Identify cause of error

   If the group 'group1' does not exist, Redis returns an error when running XREADGROUP.

3. Final Answer:

   The consumer group 'group1' does not exist -> Option A

4. Quick Check:

   Missing group = error on XREADGROUP [OK]

Hint: Create group before reading with XREADGROUP [OK]

Common Mistakes:

• Assuming empty stream causes error
• Thinking consumer name must be pre-registered
• Blaming '>' symbol placement

5. You want to process messages from a Redis stream orders using a consumer group ordergroup. You want each consumer to only get new messages and not pending ones. Which XREADGROUP ID should you use?

hard

A. >

B. 0

C. $

D. 1

Solution

1. Step 1: Understand ID meanings in XREADGROUP

   ID '0' reads all pending and new messages; '>' reads only new messages never delivered to any consumer.

2. Step 2: Choose ID for new messages only

   Using '>' ensures the consumer reads only new messages added after the command runs, skipping pending ones.

3. Final Answer:

   > -> Option A

4. Quick Check:

   ID '>' = new messages only [OK]

Hint: Use '>' to read only new messages in consumer groups [OK]

Common Mistakes:

• Using '0' reads pending messages too
• Using '$' is invalid for XREADGROUP
• Assuming '1' is a valid special ID