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

Use Case(s)

The XSETID command is used to set the last delivered ID of a stream. This can be useful when you want to manipulate the last delivered ID manually for tasks such as testing or recovery from certain scenarios.

Code Examples

In Ruby, using the redis-rb library, you can interact with Redis. Here's an example demonstrating how to use the XSETID command:

require 'redis' redis = "localhost", port: 6379) # Create a new stream if it doesn't exist redis.xadd("mystream", "*", "field", "value") # Get the last entry in the stream last_entry = redis.xrevrange("mystream", "-", "+", count: 1).first # Set the last delivered ID redis.xsetid("mystream", last_entry[0])

In this example, we first create a connection to the Redis server. We then add an entry to the stream mystream. Next, we retrieve the last entry in the stream and finally we set the last delivered ID of the stream to the ID of the last entry.

Best Practices

  • Be careful when using XSETID as it changes the internal state of the stream. Make sure that you know what you're doing before using it.
  • Use XSETID only for recovery purposes or when you are absolutely sure about the ID you are setting, otherwise unexpected behavior might occur.

Common Mistakes

  • Using XSETID without understanding its impact on the stream's internal state. It’s crucial to understand that this function manipulates the metadata of the stream which may lead to data inconsistencies if not used correctly.


  1. Can I use XSETID to set the ID to a value that doesn't exist in the stream?
    Yes, you can, but be very careful when doing so. The ID must be equal to or higher than the current last entry of the stream. Any future entry will get an auto-generated ID and it will be assigned by incrementing the highest ID in the stream.

Was this content helpful?

Start building today

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