Redis XAUTOCLAIM in PHP (Detailed Guide w/ Code Examples)

Use Case(s)

XAUTOCLAIM in Redis is typically used for managing distributed tasks in a more efficient manner. It's especially useful when multiple consumers are reading from the same stream, and you want to ensure unprocessed messages (due to consumer failures or other reasons) are claimed by another consumer and processed.

Code Examples

Let's assume we have a Redis stream called my_stream and a consumer group called my_group.

1. Declaring Redis instance and setting up XAUTOCLAIM:

<?php $redis = new Redis(); $redis->connect('', 6379); // The XAUTOCLAIM command parameters $stream = 'my_stream'; $group = 'my_group'; $consumer = 'consumer1'; $minIdleTime = 10000; $start = 0; $count = 10; $result = $redis->rawCommand('XAUTOCLAIM', $stream, $group, $consumer, $minIdleTime, $start, 'COUNT', $count); print_r($result); ?>

In this example, we're claiming messages that have been idle for at least 10000 milliseconds. We start from the beginning ($start = 0) and claim a maximum of 10 messages ($count = 10).

Best Practices

  1. Make sure the idle time is appropriate for your use case. Setting it too high might result in messages not being reclaimed fast enough in case of consumer failure, while setting it too low might lead to unnecessary processing of messages.
  2. Use XAUTOCLAIM judiciously and only when necessary as it can impact performance.

Common Mistakes

  1. Trying to use XAUTOCLAIM on a stream without having a consumer group in place. A consumer group is mandatory for this operation.
  2. Misunderstanding the $start parameter. It's not a timestamp but an ID from your stream. Setting this incorrectly could lead to unexpected results.


Q: Can I use XAUTOCLAIM with Redis Cluster? A: Yes, XAUTOCLAIM can be used with Redis Cluster. However, ensure that all keys involved are hash-tagged, otherwise you might get a CROSSSLOT error.

Q: What does the minIdleTime parameter represent in XAUTOCLAIM? A: The minIdleTime represents the minimum idle time (in milliseconds) of the pending message before it can be reclaimed by another consumer.

Was this content helpful?

Start building today

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