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

Use Case(s)

XSETID is a command used in Redis Stream data type to set the next ID for messages posted to a given stream. It's typically used when you want to control the message IDs rather than letting Redis assign them automatically. This can be useful in scenarios like:

  1. Recovering from a backup or replicating a stream
  2. Implementing custom ID strategies.

Code Examples

In this section, we will use Lettuce, a scalable thread-safe Redis client for synchronous, asynchronous, and reactive usage. The following examples illustrate how to use XSETID via Lettuce:

Example 1: Setting up a Stream and using XSETID

RedisCommands<String, String> syncCommands = connection.sync(); // Create a new stream with an initial message String streamKey = "mystream"; Map<String, String> messageBody = new HashMap<>(); messageBody.put("field", "value"); syncCommands.xadd(streamKey, messageBody); // Set the next ID for messages in the stream long nextId = 1000L; syncCommands.dispatch(CommandType.XSETID, new StatusOutput<>(StringCodec.UTF8), new CommandArgs<>(StringCodec.UTF8).addKey(streamKey).add(nextId));

In this example, we first create a Redis connection and sync commands through Lettuce. Then, we initialize a new stream called "mystream" with an arbitrary message. After that, we use XSETID to set the next message ID to 1000.

Please note that direct support for XSETID may not be available in all Redis Java clients and you might need to use the dispatch method for executing this command as shown above.

Best Practices

  1. Note that the ID you set with XSETID must be greater than any ID currently in the stream, otherwise the command will fail.
  2. Be careful when setting the ID manually, as it might lead to overwriting data if there's a mismatch between your application and Redis about the next ID.

Common Mistakes

  • A common mistake would be trying to set an ID lower or equal to the highest ID already in the stream. As mentioned above, the command will fail in such a case.


Q: What happens if we do not use XSETID? A: If you don't use XSETID, Redis will automatically assign IDs to new messages added to the stream. These IDs are made up of a timestamp and a sequence number to ensure uniqueness.

Q: Can I use XSETID on a non-existing stream? A: No, you cannot set the next ID of a non-existing stream. The stream must exist for XSETID to work.

Was this content helpful?

Start building today

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