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

Use Case(s)

The XPENDING command in Redis is commonly used to obtain detailed information on pending messages of a stream’s consumer group. This is especially useful in situations where you are dealing with data streams and have consumers that may fail or delay processing.

Code Examples

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

To begin with, we'll need to set up a connection to the Redis server:

$redis = new Redis(); $redis->connect('', 6379);

Then, to use XPENDING, you might do something like this:

// Check for any pending messages in our stream for our group $pending_messages = $redis->xPending('my_stream', 'my_group'); print_r($pending_messages);

This will return an array containing the number of pending messages for the group and additional details such as the highest and lowest message ID and consumer names.

Best Practices

  • Always handle exceptions: While working with XPENDING, ensure to catch its failure scenarios and plan accordingly.
  • Check for null: The XPENDING command returns an array when there are pending messages, but it can also return NULL if there are no pending messages. Ensure to check for NULL before processing the return value.

Common Mistakes

  • Incorrect parameters: When calling xPending, always make sure you are passing in the correct parameters in the correct order — first the stream name and then the group name.


Q: Will XPENDING lock the pending messages while they are being fetched?
A: No, XPENDING only fetches the metadata of the pending messages. It doesn't lock them or prevent other consumers from processing those messages.

Was this content helpful?

Start building today

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