Redis XGROUP in Ruby (Detailed Guide w/ Code Examples)

Use Case(s)

The XGROUP command in Redis is typically used for managing consumer groups in the context of stream data structures. The most common use cases include:

  • Creating a new consumer group associated with a stream.
  • Modifying an existing consumer group.
  • Setting the last delivered message ID for this consumer group.

Code Examples

Let's assume we're dealing with a chat application, and we want to create a consumer group for each channel. Here's how you can do it in Ruby using the redis gem.

First, we need to establish a connection with Redis.

require 'redis' redis = "localhost", port: 6379)

Example 1: Creating a Consumer Group

# Let's say we have a stream "chat:1" (representing chat channel 1) stream_key = "chat:1" group_name = "group1" # We create a new consumer group associated with the stream redis.xgroup(:create, stream_key, group_name, '$', mkstream: true)

In this example, '$' represents the latest message in the stream. When a new consumer joins this group, they will start receiving messages which were added to the stream after the group was created. mkstream: true option means it will create the stream if it doesn't exist.

Example 2: Setting the Last Delivered Message ID for a Consumer Group

last_delivered_id = "1526985755631-0" redis.xgroup(:setid, stream_key, group_name, last_delivered_id)

This sets the last delivered ID to the specified value, meaning that consumers will receive messages with IDs greater than this.

Best Practices

  • It's recommended to handle exceptions for creating consumer groups in your code. If the group already exists, an exception is thrown.
  • Be careful when setting the last delivered message ID. If you set it to a value that is too high, new messages might be overlooked.
  • Always close the connection to Redis once your work is finished.

Common Mistakes

  • Attempting to create a consumer group which already exists. This results in an error, so always check whether a group exists before trying to create it.
  • Not handling the situation where the server is not responding or unavailable. Always implement retry logic and timeouts.


Q: Can I use XGROUP command on non-stream keys?

A: No, XGROUP command only applies to stream data structures. Using it on non-stream keys will result in an error.

Q: What happens if I don't provide the mkstream option when creating a group?

A: If the stream doesn't exist and mkstream option is not provided, Redis will return an error.

Was this content helpful?

Start building today

Dragonfly is fully compatible with the Redis ecosystem and requires no code changes to implement.