Method: Redis::Commands::Streams#xautoclaim

Defined in:

lib/redis/commands/streams.rb

#xautoclaim(key, group, consumer, min_idle_time, start, count: nil, justid: false) ⇒ Hash{String => Hash}, Array<String>

Transfers ownership of pending stream entries that match the specified criteria.

Examples:

Claim next pending message stuck > 5 minutes and mark as retry

redis.xautoclaim('mystream', 'mygroup', 'consumer1', 3600000, '0-0')

Claim 50 next pending messages stuck > 5 minutes and mark as retry

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, '0-0', count: 50)

Claim next pending message stuck > 5 minutes and don't mark as retry

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, '0-0', justid: true)

Claim next pending message after this id stuck > 5 minutes and mark as retry

redis.xautoclaim('mystream', 'mygroup', 'consumer1', 3600000, '1641321233-0')

Parameters:

• key (String) —

  the stream key

• group (String) —

  the consumer group name

• consumer (String) —

  the consumer name

• min_idle_time (Integer) —

  the number of milliseconds

• start (String) —

  entry id to start scanning from or 0-0 for everything

• count (Integer) (defaults to: nil) —

  number of messages to claim (default 1)

• justid (Boolean) (defaults to: false) —

  whether to fetch just an array of entry ids or not. Does not increment retry count when true

Returns:

• (Hash{String => Hash}) —

  the entries successfully claimed

• (Array<String>) —

  the entry ids successfully claimed if justid option is true

# File 'lib/redis/commands/streams.rb', line 343

def xautoclaim(key, group, consumer, min_idle_time, start, count: nil, justid: false)
  args = [:xautoclaim, key, group, consumer, min_idle_time, start]
  if count
    args << 'COUNT' << count.to_s
  end
  args << 'JUSTID' if justid
  blk = justid ? HashifyStreamAutoclaimJustId : HashifyStreamAutoclaim
  send_command(args, &blk)
end