Method: Redis::Commands::Streams#xreadgroup

Defined in:

lib/redis/commands/streams.rb

#xreadgroup(group, consumer, keys, ids, count: nil, block: nil, noack: nil) ⇒ Hash{String => Hash{String => Hash}}

Fetches a subset of the entries from one or multiple streams related with the consumer group. Optionally blocking.

Examples:

With a key

redis.xreadgroup('mygroup', 'consumer1', 'mystream', '>')

With multiple keys

redis.xreadgroup('mygroup', 'consumer1', %w[mystream1 mystream2], %w[> >])

With count option

redis.xreadgroup('mygroup', 'consumer1', 'mystream', '>', count: 2)

With block option

redis.xreadgroup('mygroup', 'consumer1', 'mystream', '>', block: 1000)

With noack option

redis.xreadgroup('mygroup', 'consumer1', 'mystream', '>', noack: true)

Parameters:

• group (String) —

  the consumer group name

• consumer (String) —

  the consumer name

• keys (Array<String>) —

  one or multiple stream keys

• ids (Array<String>) —

  one or multiple entry ids

• opts (Hash) —

  several options for ‘XREADGROUP` command

Returns:

• (Hash{String => Hash{String => Hash}}) —

  the entries

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

def xreadgroup(group, consumer, keys, ids, count: nil, block: nil, noack: nil)
  args = [:xreadgroup, 'GROUP', group, consumer]
  args << 'COUNT' << count if count
  args << 'BLOCK' << block.to_i if block
  args << 'NOACK' if noack
  _xread(args, keys, ids, block)
end