Method: Redis::Commands::Streams#xclaim

Defined in:

lib/redis/commands/streams.rb

#xclaim(key, group, consumer, min_idle_time, *ids, **opts) ⇒ Hash{String => Hash}, Array<String>

Changes the ownership of a pending entry

Examples:

With splatted entry ids

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, '0-1', '0-2')

With arrayed entry ids

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2])

With idle option

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], idle: 1000)

With time option

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], time: 1542866959000)

With retrycount option

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], retrycount: 10)

With force option

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], force: true)

With justid option

redis.xclaim('mystream', 'mygroup', 'consumer1', 3600000, %w[0-1 0-2], justid: true)

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

• ids (Array<String>) —

  one or multiple entry ids

• opts (Hash) —

  several options for XCLAIM command

Options Hash (**opts):

• :idle (Integer) —

  the number of milliseconds as last time it was delivered of the entry

• :time (Integer) —

  the number of milliseconds as a specific Unix Epoch time

• :retrycount (Integer) —

  the number of retry counter

• :force (Boolean) —

  whether to create the pending entry to the pending entries list or not

• :justid (Boolean) —

  whether to fetch just an array of entry ids or not

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 310

def xclaim(key, group, consumer, min_idle_time, *ids, **opts)
  args = [:xclaim, key, group, consumer, min_idle_time].concat(ids.flatten)
  args.concat(['IDLE',       opts[:idle].to_i])  if opts[:idle]
  args.concat(['TIME',       opts[:time].to_i])  if opts[:time]
  args.concat(['RETRYCOUNT', opts[:retrycount]]) if opts[:retrycount]
  args << 'FORCE'                                if opts[:force]
  args << 'JUSTID'                               if opts[:justid]
  blk = opts[:justid] ? Noop : HashifyStreamEntries
  send_command(args, &blk)
end