Method: Redis#zadd

Defined in:

lib/redis.rb

#zadd(key, *args) ⇒ Boolean, ...

Add one or more members to a sorted set, or update the score for members that already exist.

Examples:

Add a single [score, member] pair to a sorted set

redis.zadd("zset", 32.0, "member")

Add an array of [score, member] pairs to a sorted set

redis.zadd("zset", [[32.0, "a"], [64.0, "b"]])

Parameters:

• key (String)
• args ([Float, String], Array<[Float, String]>) —
  • a single [score, member] pair
  • an array of [score, member] pairs
• options (Hash) —
  • :xx => true: Only update elements that already exist (never add elements)
  • :nx => true: Don't update already existing elements (always add new elements)
  • :ch => true: Modify the return value from the number of new elements added, to the total number of elements changed (CH is an abbreviation of changed); changed elements are new elements added and elements already existing for which the score was updated
  • :incr => true: When this option is specified ZADD acts like ZINCRBY; only one score-element pair can be specified in this mode

Returns:

• (Boolean, Fixnum, Float) —
  • Boolean when a single pair is specified, holding whether or not it was added to the sorted set.
  • Fixnum when an array of pairs is specified, holding the number of pairs that were added to the sorted set.
  • Float when option :incr is specified, holding the score of the member after incrementing it.

# File 'lib/redis.rb', line 1510

def zadd(key, *args) #, options
  zadd_options = []
  if args.last.is_a?(Hash)
    options = args.pop

    nx = options[:nx]
    zadd_options << "NX" if nx

    xx = options[:xx]
    zadd_options << "XX" if xx

    ch = options[:ch]
    zadd_options << "CH" if ch

    incr = options[:incr]
    zadd_options << "INCR" if incr
  end

  synchronize do |client|
    if args.size == 1 && args[0].is_a?(Array)
      # Variadic: return float if INCR, integer if !INCR
      client.call([:zadd, key] + zadd_options + args[0], &(incr ? Floatify : nil))
    elsif args.size == 2
      # Single pair: return float if INCR, boolean if !INCR
      client.call([:zadd, key] + zadd_options + args, &(incr ? Floatify : Boolify))
    else
      raise ArgumentError, "wrong number of arguments"
    end
  end
end