Method: Redis::Commands::Streams#xinfo

Defined in:
lib/redis/commands/streams.rb

#xinfo(subcommand, key, group = nil) ⇒ Hash+

Returns the stream information each subcommand.

Examples:

stream

redis.xinfo(:stream, 'mystream')

groups

redis.xinfo(:groups, 'mystream')

consumers

redis.xinfo(:consumers, 'mystream', 'mygroup')

Parameters:

  • subcommand (String) —

    e.g. stream groups consumers

  • key (String) —

    the stream key

  • group (String) (defaults to: nil) —

    the consumer group name, required if subcommand is consumers

Returns:

  • (Hash) —

    information of the stream if subcommand is stream

  • (Array<Hash>) —

    information of the consumer groups if subcommand is groups

  • (Array<Hash>) —

    information of the consumers if subcommand is consumers



22
23
24
25
26
27
28
29
30
 
# File 'lib/redis/commands/streams.rb', line 22

def xinfo(subcommand, key, group = nil)
  args = [:xinfo, subcommand, key, group].compact
  block = case subcommand.to_s.downcase
  when 'stream'              then Hashify
  when 'groups', 'consumers' then proc { |r| r.map(&Hashify) }
  end

  send_command(args, &block)
end