Method: Redis::Commands::SortedSets#zrangebyscore

Defined in:

lib/redis/commands/sorted_sets.rb

#zrangebyscore(key, min, max, withscores: false, with_scores: withscores, limit: nil) ⇒ Array<String>, Array<[String, Float]>

Return a range of members in a sorted set, by score.

Examples:

Retrieve members with score ‘>= 5` and `< 100`

redis.zrangebyscore("zset", "5", "(100")
  # => ["a", "b"]

Retrieve the first 2 members with score ‘>= 0`

redis.zrangebyscore("zset", "0", "+inf", :limit => [0, 2])
  # => ["a", "b"]

Retrieve members and their scores with scores ‘> 5`

redis.zrangebyscore("zset", "(5", "+inf", :with_scores => true)
  # => [["a", 32.0], ["b", 64.0]]

Parameters:

• key (String)
• min (String) —

  • inclusive minimum score is specified verbatim

  • exclusive minimum score is specified by prefixing ‘(`

• max (String) —

  • inclusive maximum score is specified verbatim

  • exclusive maximum score is specified by prefixing ‘(`

• options (Hash) —

  • ‘:with_scores => true`: include scores in output

  • ‘:limit => [offset, count]`: skip `offset` members, return a maximum of

  ‘count` members

Returns:

• (Array<String>, Array<[String, Float]>) —

  • when ‘:with_scores` is not specified, an array of members

  • when ‘:with_scores` is specified, an array with `[member, score]` pairs

# File 'lib/redis/commands/sorted_sets.rb', line 528

def zrangebyscore(key, min, max, withscores: false, with_scores: withscores, limit: nil)
  args = [:zrangebyscore, key, min, max]

  if with_scores
    args << "WITHSCORES"
    block = FloatifyPairs
  end

  if limit
    args << "LIMIT"
    args.concat(limit.map { |l| Integer(l) })
  end

  send_command(args, &block)
end