Class: Familia::SortedSet

Inherits:
DataType show all
Includes:
DataType::CollectionBase
Defined in:
lib/familia/data_type/types/sorted_set.rb

Instance Attribute Summary collapse

Attributes included from Settings

#current_key_version, #default_expiration, #delim, #encryption_keys, #encryption_personalization, #logical_database, #prefix, #schema_path, #schema_validator, #schemas, #strict_write_order, #suffix, #transaction_mode

Instance Method Summary collapse

Methods included from DataType::CollectionBase

#collection_type?, #each_record

Methods included from Features::Autoloader

autoload_files, included, normalize_to_config_name

Methods included from DataType::Serialization

#deserialize_value, #deserialize_values, #deserialize_values_with_nil, #serialize_value

Methods included from DataType::DatabaseCommands

#current_expiration, #delete!, #echo, #exists?, #expire, #expireat, #move, #persist, #rename, #renamenx, #type

Methods included from DataType::Connection

#dbclient, #dbkey, #uri

Methods included from Connection::Behavior

#connect, #create_dbclient, #multi, #normalize_uri, #pipeline, #pipelined, #transaction, #uri=, #url, #url=

Methods included from Settings

#configure, #default_suffix, #pipelined_mode, #pipelined_mode=

Methods included from Base

add_feature, #as_json, #expired?, #expires?, find_feature, #generate_id, #to_json, #to_s, #ttl, #update_expiration, #uuid

Constructor Details

This class inherits a constructor from Familia::DataType

Instance Attribute Details

#features_enabled ⇒ Object (readonly) Originally defined in module Features

Returns the value of attribute features_enabled.

#logical_database(val = nil) ⇒ Object Originally defined in module DataType::ClassMethods

#parent ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute parent.

#prefix ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute prefix.

#suffix ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute suffix.

#uri(val = nil) ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute uri.

Instance Method Details

#<<(val) ⇒ Integer

Note:

This is a non-standard operation for sorted sets as it doesn't allow specifying a custom score. Use add or []= for more control.

Adds a new element to the sorted set with the current timestamp as the score.

This method provides a convenient way to add elements to the sorted set without explicitly specifying a score. It uses the current Unix timestamp as the score, which effectively sorts elements by their insertion time.

Examples:

sorted_set << "new_element"

Parameters:

  • val (Object) —

    The value to be added to the sorted set.

Returns:

  • (Integer) —

    Returns 1 if the element is new and added, 0 if the element already existed and the score was updated.



38
39
40
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 38

def <<(val)
  add(val)
end

#[]=(val, score) ⇒ Object

NOTE: The argument order is the reverse of #add. We do this to more naturally align with how the [] and []= methods are used.

e.g. obj.metrics[VALUE] = SCORE obj.metrics[VALUE] # => SCORE



49
50
51
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 49

def []=(val, score)
  add val, score
end

#add(val, score = nil, nx: false, xx: false, gt: false, lt: false, ch: false) ⇒ Boolean Also known as: add_element

Note:

GT and LT options do NOT prevent adding new elements, they only affect update behavior for existing elements.

Note:

Default behavior (no options) adds new elements and updates existing ones unconditionally, matching standard Redis ZADD semantics.

Note:

INCR option is not supported. Use the increment method for ZINCRBY operations.

Note:

This method executes a Redis ZADD immediately, unlike scalar field setters which are deferred until save. If the parent object has unsaved scalar field changes, consider calling save first to avoid split-brain state.

Adds an element to the sorted set with an optional score and ZADD options.

This method supports Redis ZADD options for conditional adds and updates:

  • NX: Only add new elements (don't update existing)
  • XX: Only update existing elements (don't add new)
  • GT: Only update if new score > current score
  • LT: Only update if new score < current score
  • CH: Return changed count (new + updated) instead of just new count

Examples:

Add new element with timestamp

metrics.add('pageview', Familia.now.to_f)  #=> true

Preserve original timestamp on subsequent saves

index.add(email, Familia.now.to_f, nx: true)  #=> true
index.add(email, Familia.now.to_f, nx: true)  #=> false (unchanged)

Update timestamp only for existing entries

index.add(email, Familia.now.to_f, xx: true)  #=> false (if doesn't exist)

Only update if new score is higher (leaderboard)

scores.add(player, 1000, gt: true)  #=> true (new entry)
scores.add(player, 1500, gt: true)  #=> false (updated)
scores.add(player, 1200, gt: true)  #=> false (not updated, score lower)

Track total changes for analytics

changed = metrics.add(user, score, ch: true)  #=> true (new or updated)

Combined options: only update existing, only if score increases

index.add(key, new_score, xx: true, gt: true)

Parameters:

  • val (Object) —

    The value to add to the sorted set

  • score (Numeric, nil) (defaults to: nil) —

    The score for ranking (defaults to current timestamp)

  • nx (Boolean) (defaults to: false) —

    Only add new elements, don't update existing (default: false)

  • xx (Boolean) (defaults to: false) —

    Only update existing elements, don't add new (default: false)

  • gt (Boolean) (defaults to: false) —

    Only update if new score > current score (default: false)

  • lt (Boolean) (defaults to: false) —

    Only update if new score < current score (default: false)

  • ch (Boolean) (defaults to: false) —

    Return changed count instead of added count (default: false)

Returns:

  • (Boolean) —

    Returns the return value from the redis gem's ZADD command. Returns true if element was added or changed (with CH option), false if element score was updated without change tracking or no operation occurred due to option constraints (NX, XX, GT, LT).

Raises:

  • (ArgumentError) —

    If mutually exclusive options are specified together (NX+XX, GT+LT, NX+GT, NX+LT)



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 111

def add(val, score = nil, nx: false, xx: false, gt: false, lt: false, ch: false)
  warn_if_dirty!
  score ||= Familia.now

  # Validate mutual exclusivity
  validate_zadd_options!(nx: nx, xx: xx, gt: gt, lt: lt)

  # Build options hash for redis gem
  opts = {}
  opts[:nx] = true if nx
  opts[:xx] = true if xx
  opts[:gt] = true if gt
  opts[:lt] = true if lt
  opts[:ch] = true if ch

  # Pass options to ZADD
  ret = if opts.empty?
    dbclient.zadd(dbkey, score, serialize_value(val))
  else
    dbclient.zadd(dbkey, score, serialize_value(val), **opts)
  end

  update_expiration
  ret
end

#at(idx) ⇒ Object 



403
404
405
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 403

def at(idx)
  range(idx, idx).first
end

#collectraw ⇒ Object 



309
310
311
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 309

def collectraw(&)
  membersraw.collect(&)
end

#decrement(val, by = 1) ⇒ Object Also known as: decr, decrby 



385
386
387
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 385

def decrement(val, by = 1)
  increment val, -by
end

#diff(*other_sets, withscores: false) ⇒ Array

Returns the difference between this sorted set and other sorted sets.

Examples:

Difference of two sorted sets

zset.diff(other_zset)  #=> ["unique_member"]

Parameters:

  • other_sets (Array<SortedSet, String>) —

    Other sorted sets or key names

  • withscores (Boolean) (defaults to: false) —

    Whether to include scores in result

Returns:

  • (Array) —

    Members in this set but not in other sets



727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 727

def diff(*other_sets, withscores: false)
  keys = [dbkey] + resolve_set_keys(other_sets)

  result = if withscores
    dbclient.zdiff(*keys, withscores: true)
  else
    dbclient.zdiff(*keys)
  end

  process_set_operation_result(result, withscores: withscores)
end

#diffstore(destination, *other_sets) ⇒ Integer

Stores the difference of sorted sets into a destination key.

Parameters:

  • destination (String) —

    Destination key name

  • other_sets (Array<SortedSet, String>) —

    Other sorted sets or key names

Returns:

  • (Integer) —

    Number of elements in the resulting sorted set



745
746
747
748
749
750
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 745

def diffstore(destination, *other_sets)
  keys = [dbkey] + resolve_set_keys(other_sets)
  result = dbclient.zdiffstore(destination, keys)
  update_expiration
  result
end

#each(since: nil, batch_size: 100, **kwargs) {|member| ... } ⇒ Enumerator, self

Note:

The until: parameter uses Ruby keyword syntax. Since until is a reserved word, it's accessed via **kwargs internally.

Note:

Score-cursor pagination: bounded queries paginate using the last seen score as the next exclusive minimum. This is O(n) total work, unlike offset-based LIMIT which is O(n²). However, members with identical scores may be skipped between pages. Use high-precision floats (e.g., Familia.now) for scores to avoid collisions.

Iterates over members of the sorted set.

When called with score bounds (since/until), uses ZRANGEBYSCORE for efficient range queries. Otherwise uses ZSCAN for memory-efficient iteration over large sets.

Examples:

Iterate all members

scores.each { |member| puts member }

Iterate members within time range

scores.each(since: 1.hour.ago, until: Time.now) { |m| process(m) }

Parameters:

  • since (Numeric, Time, nil) (defaults to: nil) —

    Minimum score (inclusive). Time objects are converted to float timestamps.

  • until (Numeric, Time, nil) —

    Maximum score (inclusive). Time objects are converted to float timestamps. Use kwargs syntax: until: value.

  • batch_size (Integer) (defaults to: 100) —

    Number of elements to fetch per ZSCAN iteration (only used when no score bounds provided)

Yields:

  • (member) —

    Each deserialized member

Returns:

  • (Enumerator, self) —

    Returns Enumerator if no block given, self otherwise

Raises:

  • (ArgumentError) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 261

def each(since: nil, batch_size: 100, **kwargs, &block)
  until_score = kwargs.delete(:until)
  raise ArgumentError, "unknown keyword(s): #{kwargs.keys.join(', ')}" if kwargs.any?

  return to_enum(:each, since: since, until: until_score, batch_size: batch_size) unless block

  # Convert Time objects to numeric scores
  since_score = since.is_a?(Time) ? since.to_f : since
  until_score_val = until_score.is_a?(Time) ? until_score.to_f : until_score

  if since_score || until_score_val
    # Score-cursor pagination: track last score, use exclusive bound for next page
    min = since_score || '-inf'
    max = until_score_val || '+inf'
    loop do
      # with_scores returns nested pairs: [["a", 1.0], ["b", 2.0]]
      pairs = rangebyscoreraw(min, max, limit: [0, batch_size], with_scores: true)
      break if pairs.empty?

      pairs.each do |raw_member, score|
        yield deserialize_value(raw_member)
        min = "(#{score}" # exclusive bound for next iteration
      end

      break if pairs.size < batch_size
    end
  else
    # Use ZSCAN for unbounded iteration (memory-efficient)
    cursor = 0
    loop do
      new_cursor, pairs = scan(cursor, count: batch_size)
      pairs.each { |member, _score| block.call(member) }
      cursor = new_cursor
      break if cursor.zero?
    end
  end

  self
end

#eachraw ⇒ Object 



301
302
303
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 301

def eachraw(&)
  membersraw.each(&)
end

#eachraw_with_index ⇒ Object 



305
306
307
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 305

def eachraw_with_index(&)
  membersraw.each_with_index(&)
end

#element_count ⇒ Integer Also known as: size, length, count

Returns the number of elements in the sorted set

Returns:

  • (Integer) —

    number of elements



11
12
13
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 11

def element_count
  dbclient.zcard dbkey
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 18

def empty?
  element_count.zero?
end

#first ⇒ Object

Return the first element in the list. Redis: ZRANGE(0)



408
409
410
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 408

def first
  at(0)
end

#increment(val, by = 1) ⇒ Object Also known as: incr, incrby 



377
378
379
380
381
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 377

def increment(val, by = 1)
  ret = dbclient.zincrby(dbkey, by, serialize_value(val)).to_f
  update_expiration
  ret
end

#inter(*other_sets, weights: nil, aggregate: nil, withscores: false) ⇒ Array

Returns the intersection of this sorted set with other sorted sets.

Examples:

Intersection of two sorted sets

zset.inter(other_zset)  #=> ["common_member"]

Parameters:

  • other_sets (Array<SortedSet, String>) —

    Other sorted sets or key names

  • weights (Array<Numeric>, nil) (defaults to: nil) —

    Multiplication factors for each set's scores

  • aggregate (Symbol, nil) (defaults to: nil) —

    How to aggregate scores (:sum, :min, :max)

Returns:

  • (Array) —

    Array of members (or [member, score] pairs with withscores)



556
557
558
559
560
561
562
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 556

def inter(*other_sets, weights: nil, aggregate: nil, withscores: false)
  keys = [dbkey] + resolve_set_keys(other_sets)
  opts = build_set_operation_opts(weights: weights, aggregate: aggregate, withscores: withscores)

  result = dbclient.zinter(*keys, **opts)
  process_set_operation_result(result, withscores: withscores)
end

#interstore(destination, *other_sets, weights: nil, aggregate: nil) ⇒ Integer

Stores the intersection of sorted sets into a destination key.

Parameters:

  • destination (String) —

    Destination key name

  • other_sets (Array<SortedSet, String>) —

    Other sorted sets or key names

  • weights (Array<Numeric>, nil) (defaults to: nil) —

    Multiplication factors for each set's scores

  • aggregate (Symbol, nil) (defaults to: nil) —

    How to aggregate scores (:sum, :min, :max)

Returns:

  • (Integer) —

    Number of elements in the resulting sorted set



709
710
711
712
713
714
715
716
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 709

def interstore(destination, *other_sets, weights: nil, aggregate: nil)
  keys = [dbkey] + resolve_set_keys(other_sets)
  opts = build_set_operation_opts(weights: weights, aggregate: aggregate)

  result = dbclient.zinterstore(destination, keys, **opts)
  update_expiration
  result
end

#last ⇒ Object

Return the last element in the list. Redis: ZRANGE(-1)



413
414
415
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 413

def last
  at(-1)
end

#lexcount(min, max) ⇒ Integer

Counts members in a lexicographical range.

Parameters:

  • min (String) —

    Minimum lex value

  • max (String) —

    Maximum lex value

Returns:

  • (Integer) —

    Number of members in the range



613
614
615
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 613

def lexcount(min, max)
  dbclient.zlexcount(dbkey, min, max)
end

#member?(val) ⇒ Boolean Also known as: include?

Returns:

  • (Boolean) 


189
190
191
192
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 189

def member?(val)
  Familia.trace :MEMBER, nil, "#{val}<#{val.class}>" if Familia.debug?
  !rank(val).nil?
end

#members(count = -1,, opts = {}) ⇒ Object Also known as: to_a, all 



207
208
209
210
211
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 207

def members(count = -1, opts = {})
  count -= 1 if count.positive?
  elements = membersraw count, opts
  deserialize_values(*elements)
end

#membersraw(count = -1,, opts = {}) ⇒ Object 



215
216
217
218
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 215

def membersraw(count = -1, opts = {})
  count -= 1 if count.positive?
  rangeraw 0, count, opts
end

#mscore(*members) ⇒ Array<Float, nil>

Gets scores for multiple members at once.

Examples:

Get scores for multiple members

zset.mscore('member1', 'member2', 'member3')  #=> [1.0, 2.0, nil]

Parameters:

  • members (Array<Object>) —

    Members to get scores for

Returns:

  • (Array<Float, nil>) —

    Scores for each member (nil if member doesn't exist)



514
515
516
517
518
519
520
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 514

def mscore(*members)
  return [] if members.empty?

  serialized = members.map { |m| serialize_value(m) }
  result = dbclient.zmscore(dbkey, *serialized)
  result.map { |s| s&.to_f }
end

#popmax(count = 1) ⇒ Array?

Removes and returns the member(s) with the highest score(s).

Examples:

Pop single highest-scoring member

zset.popmax  #=> ["member1", 100.0]

Pop multiple highest-scoring members

zset.popmax(3)  #=> [["member3", 100.0], ["member2", 90.0], ["member1", 80.0]]

Parameters:

  • count (Integer) (defaults to: 1) —

    Number of members to pop (default: 1)

Returns:

  • (Array, nil) —

    Array of [member, score] pairs, or single pair if count=1, or nil if set is empty



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 465

def popmax(count = 1)
  warn_if_dirty!
  # Normalize explicit nil to the default so the structural dispatch below
  # behaves identically whether the arg is omitted or passed as nil.
  # redis-rb treats nil as count <= 1 and returns a flat pair.
  count = 1 if count.nil?
  result = dbclient.zpopmax(dbkey, count)
  return nil if result.nil? || result.empty?

  update_expiration

  # redis-rb returns a flat [member, score] pair when count <= 1, and a
  # nested [[member, score], ...] array when count > 1. Normalize by
  # inspecting the result's structure rather than relying on count alone,
  # so that a redis-rb version change or a member that serializes to an
  # array-like string cannot mislead the dispatch.
  if count == 1
    pair = result.first.is_a?(Array) ? result.first : result
    [deserialize_value(pair[0]), pair[1].to_f]
  else
    result.map { |member, score| [deserialize_value(member), score.to_f] }
  end
end

#popmin(count = 1) ⇒ Array?

Removes and returns the member(s) with the lowest score(s).

Examples:

Pop single lowest-scoring member

zset.popmin  #=> ["member1", 1.0]

Pop multiple lowest-scoring members

zset.popmin(3)  #=> [["member1", 1.0], ["member2", 2.0], ["member3", 3.0]]

Parameters:

  • count (Integer) (defaults to: 1) —

    Number of members to pop (default: 1)

Returns:

  • (Array, nil) —

    Array of [member, score] pairs, or single pair if count=1, or nil if set is empty



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 429

def popmin(count = 1)
  warn_if_dirty!
  # Normalize explicit nil to the default so the structural dispatch below
  # behaves identically whether the arg is omitted or passed as nil.
  # redis-rb treats nil as count <= 1 and returns a flat pair.
  count = 1 if count.nil?
  result = dbclient.zpopmin(dbkey, count)
  return nil if result.nil? || result.empty?

  update_expiration

  # redis-rb returns a flat [member, score] pair when count <= 1, and a
  # nested [[member, score], ...] array when count > 1. Normalize by
  # inspecting the result's structure rather than relying on count alone,
  # so that a redis-rb version change or a member that serializes to an
  # array-like string cannot mislead the dispatch.
  if count == 1
    pair = result.first.is_a?(Array) ? result.first : result
    [deserialize_value(pair[0]), pair[1].to_f]
  else
    result.map { |member, score| [deserialize_value(member), score.to_f] }
  end
end

#randmember(count = nil, withscores: false) ⇒ Object, ...

Returns random member(s) from the sorted set.

Examples:

Get single random member

zset.randmember  #=> "member1"

Get 3 random members

zset.randmember(3)  #=> ["member1", "member2", "member3"]

Get random member with score

zset.randmember(1, withscores: true)  #=> [["member1", 1.0]]

Parameters:

  • count (Integer, nil) (defaults to: nil) —

    Number of members to return (nil for single member)

  • withscores (Boolean) (defaults to: false) —

    Whether to include scores in result

Returns:

  • (Object, Array, nil) —

    Random member(s), or nil if set is empty



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 632

def randmember(count = nil, withscores: false)
  if count.nil?
    result = dbclient.zrandmember(dbkey)
    return nil if result.nil?

    deserialize_value(result)
  else
    result = if withscores
      dbclient.zrandmember(dbkey, count, withscores: true)
    else
      dbclient.zrandmember(dbkey, count)
    end

    return [] if result.nil? || result.empty?

    if withscores
      result.map { |member, score| [deserialize_value(member), score.to_f] }
    else
      deserialize_values(*result)
    end
  end
end

#range(sidx, eidx, opts = {}) ⇒ Object 



317
318
319
320
321
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 317

def range(sidx, eidx, opts = {})
  echo :range, Familia.pretty_stack(limit: 1) if Familia.debug
  elements = rangeraw(sidx, eidx, opts)
  deserialize_values(*elements)
end

#rangebylex(min, max, limit: nil) ⇒ Array

Returns members in a lexicographical range (requires all members have same score).

Examples:

Get members between 'a' and 'z' (inclusive)

zset.rangebylex('[a', '[z')  #=> ["apple", "banana", "cherry"]

Get first 10 members starting with 'a'

zset.rangebylex('[a', '(b', limit: [0, 10])

Parameters:

  • min (String) —

    Minimum lex value (use '-' for unbounded, '[' or '(' prefix for inclusive/exclusive)

  • max (String) —

    Maximum lex value (use '+' for unbounded, '[' or '(' prefix for inclusive/exclusive)

  • limit (Array<Integer>, nil) (defaults to: nil) —

    [offset, count] for pagination

Returns:

  • (Array) —

    Members in the lexicographical range



577
578
579
580
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 577

def rangebylex(min, max, limit: nil)
  result = dbclient.zrangebylex(dbkey, min, max, limit: limit)
  deserialize_values(*result)
end

#rangebyscore(sscore, escore, opts = {}) ⇒ Object

e.g. obj.metrics.rangebyscore (now-12.hours), now, :limit => [0, 10]



339
340
341
342
343
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 339

def rangebyscore(sscore, escore, opts = {})
  echo :rangebyscore, Familia.pretty_stack(limit: 1) if Familia.debug
  elements = rangebyscoreraw(sscore, escore, opts)
  deserialize_values(*elements)
end

#rangebyscoreraw(sscore, escore, opts = {}) ⇒ Object 



345
346
347
348
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 345

def rangebyscoreraw(sscore, escore, opts = {})
  echo :rangebyscoreraw, Familia.pretty_stack(limit: 1) if Familia.debug
  dbclient.zrangebyscore(dbkey, sscore, escore, **opts)
end

#rangeraw(sidx, eidx, opts = {}) ⇒ Object 



323
324
325
326
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 323

def rangeraw(sidx, eidx, opts = {})
  # NOTE: Redis 5.x gem uses :with_scores (with underscore)
  dbclient.zrange(dbkey, sidx, eidx, **opts)
end

#rank(v) ⇒ Object

rank of member +v+ when ordered lowest to highest (starts at 0)



196
197
198
199
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 196

def rank(v)
  ret = dbclient.zrank dbkey, serialize_value(v)
  ret&.to_i
end

#remove_element(value) ⇒ Integer Also known as: remove

Removes a member from the sorted set

Parameters:

  • value —

    The value to remove from the sorted set

Returns:

  • (Integer) —

    The number of members that were removed (0 or 1)



394
395
396
397
398
399
400
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 394

def remove_element(value)
  warn_if_dirty!
  Familia.trace :REMOVE_ELEMENT, nil, "#{value}<#{value.class}>" if Familia.debug?
  ret = dbclient.zrem dbkey, serialize_value(value)
  update_expiration
  ret
end

#remrangebylex(min, max) ⇒ Integer

Removes members in a lexicographical range.

Parameters:

  • min (String) —

    Minimum lex value

  • max (String) —

    Maximum lex value

Returns:

  • (Integer) —

    Number of members removed



600
601
602
603
604
605
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 600

def remrangebylex(min, max)
  warn_if_dirty!
  result = dbclient.zremrangebylex(dbkey, min, max)
  update_expiration
  result
end

#remrangebyrank(srank, erank) ⇒ Object 



363
364
365
366
367
368
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 363

def remrangebyrank(srank, erank)
  warn_if_dirty!
  ret = dbclient.zremrangebyrank dbkey, srank, erank
  update_expiration
  ret
end

#remrangebyscore(sscore, escore) ⇒ Object 



370
371
372
373
374
375
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 370

def remrangebyscore(sscore, escore)
  warn_if_dirty!
  ret = dbclient.zremrangebyscore dbkey, sscore, escore
  update_expiration
  ret
end

#revmembers(count = -1,, opts = {}) ⇒ Object 



220
221
222
223
224
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 220

def revmembers(count = -1, opts = {})
  count -= 1 if count.positive?
  elements = revmembersraw count, opts
  deserialize_values(*elements)
end

#revmembersraw(count = -1,, opts = {}) ⇒ Object 



226
227
228
229
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 226

def revmembersraw(count = -1, opts = {})
  count -= 1 if count.positive?
  revrangeraw 0, count, opts
end

#revrange(sidx, eidx, opts = {}) ⇒ Object 



328
329
330
331
332
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 328

def revrange(sidx, eidx, opts = {})
  echo :revrange, Familia.pretty_stack(limit: 1) if Familia.debug
  elements = revrangeraw(sidx, eidx, opts)
  deserialize_values(*elements)
end

#revrangebylex(max, min, limit: nil) ⇒ Array

Returns members in reverse lexicographical range.

Parameters:

  • max (String) —

    Maximum lex value (use '+' for unbounded)

  • min (String) —

    Minimum lex value (use '-' for unbounded)

  • limit (Array<Integer>, nil) (defaults to: nil) —

    [offset, count] for pagination

Returns:

  • (Array) —

    Members in reverse lexicographical range



589
590
591
592
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 589

def revrangebylex(max, min, limit: nil)
  result = dbclient.zrevrangebylex(dbkey, max, min, limit: limit)
  deserialize_values(*result)
end

#revrangebyscore(sscore, escore, opts = {}) ⇒ Object

e.g. obj.metrics.revrangebyscore (now-12.hours), now, :limit => [0, 10]



351
352
353
354
355
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 351

def revrangebyscore(sscore, escore, opts = {})
  echo :revrangebyscore, Familia.pretty_stack(limit: 1) if Familia.debug
  elements = revrangebyscoreraw(sscore, escore, opts)
  deserialize_values(*elements)
end

#revrangebyscoreraw(sscore, escore, opts = {}) ⇒ Object 



357
358
359
360
361
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 357

def revrangebyscoreraw(sscore, escore, opts = {})
  echo :revrangebyscoreraw, Familia.pretty_stack(limit: 1) if Familia.debug
  opts[:with_scores] = true if opts[:withscores]
  dbclient.zrevrangebyscore(dbkey, sscore, escore, **opts)
end

#revrangeraw(sidx, eidx, opts = {}) ⇒ Object 



334
335
336
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 334

def revrangeraw(sidx, eidx, opts = {})
  dbclient.zrevrange(dbkey, sidx, eidx, **opts)
end

#revrank(v) ⇒ Object

rank of member +v+ when ordered highest to lowest (starts at 0)



202
203
204
205
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 202

def revrank(v)
  ret = dbclient.zrevrank dbkey, serialize_value(v)
  ret&.to_i
end

#scan(cursor = 0, match: nil, count: nil) ⇒ Array

Iterates over members using cursor-based scanning.

Examples:

Scan all members

cursor = 0
loop do
  cursor, members = zset.scan(cursor)
  members.each { |member, score| puts "#{member}: #{score}" }
  break if cursor == 0
end

Scan with pattern matching

cursor, members = zset.scan(0, match: 'user:*', count: 100)

Parameters:

  • cursor (Integer) (defaults to: 0) —

    Cursor position (0 to start)

  • match (String, nil) (defaults to: nil) —

    Pattern to match member names

  • count (Integer, nil) (defaults to: nil) —

    Hint for number of elements to return per call

Returns:

  • (Array) —

    [new_cursor, [[member, score], ...]]



673
674
675
676
677
678
679
680
681
682
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 673

def scan(cursor = 0, match: nil, count: nil)
  opts = {}
  opts[:match] = match if match
  opts[:count] = count if count

  new_cursor, result = dbclient.zscan(dbkey, cursor, **opts)

  members = result.map { |member, score| [deserialize_value(member), score.to_f] }
  [new_cursor.to_i, members]
end

#score(val) ⇒ Object Also known as: [] 



183
184
185
186
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 183

def score(val)
  ret = dbclient.zscore dbkey, serialize_value(val)
  ret&.to_f
end

#score_count(min, max) ⇒ Integer Also known as: zcount

Counts members within a score range.

Examples:

Count members with scores between 10 and 100

zset.score_count(10, 100)  #=> 5

Count members with scores up to 50

zset.score_count('-inf', 50)  #=> 3

Parameters:

  • min (Numeric, String) —

    Minimum score (use '-inf' for unbounded)

  • max (Numeric, String) —

    Maximum score (use '+inf' for unbounded)

Returns:

  • (Integer) —

    Number of members with scores in the range



501
502
503
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 501

def score_count(min, max)
  dbclient.zcount(dbkey, min, max)
end

#selectraw ⇒ Object 



313
314
315
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 313

def selectraw(&)
  membersraw.select(&)
end

#union(*other_sets, weights: nil, aggregate: nil, withscores: false) ⇒ Array

Returns the union of this sorted set with other sorted sets.

Examples:

Union of two sorted sets

zset.union(other_zset)  #=> ["member1", "member2", "member3"]

Union with weighted scores

zset.union(other_zset, weights: [1, 2])

Union with score aggregation

zset.union(other_zset, aggregate: :max)

Parameters:

  • other_sets (Array<SortedSet, String>) —

    Other sorted sets or key names

  • weights (Array<Numeric>, nil) (defaults to: nil) —

    Multiplication factors for each set's scores

  • aggregate (Symbol, nil) (defaults to: nil) —

    How to aggregate scores (:sum, :min, :max)

Returns:

  • (Array) —

    Array of members (or [member, score] pairs with withscores)



538
539
540
541
542
543
544
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 538

def union(*other_sets, weights: nil, aggregate: nil, withscores: false)
  keys = [dbkey] + resolve_set_keys(other_sets)
  opts = build_set_operation_opts(weights: weights, aggregate: aggregate, withscores: withscores)

  result = dbclient.zunion(*keys, **opts)
  process_set_operation_result(result, withscores: withscores)
end

#unionstore(destination, *other_sets, weights: nil, aggregate: nil) ⇒ Integer

Stores the union of sorted sets into a destination key.

Parameters:

  • destination (String) —

    Destination key name

  • other_sets (Array<SortedSet, String>) —

    Other sorted sets or key names

  • weights (Array<Numeric>, nil) (defaults to: nil) —

    Multiplication factors for each set's scores

  • aggregate (Symbol, nil) (defaults to: nil) —

    How to aggregate scores (:sum, :min, :max)

Returns:

  • (Integer) —

    Number of elements in the resulting sorted set



692
693
694
695
696
697
698
699
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 692

def unionstore(destination, *other_sets, weights: nil, aggregate: nil)
  keys = [dbkey] + resolve_set_keys(other_sets)
  opts = build_set_operation_opts(weights: weights, aggregate: aggregate)

  result = dbclient.zunionstore(destination, keys, **opts)
  update_expiration
  result
end

#update(hsh = {}) ⇒ Integer Also known as: merge!

Note:

Unlike single-value #add, scores are required: this bulk path does not default a missing score to Familia.now. A non-Numeric score (e.g. nil) raises ArgumentError rather than surfacing a low-level client error.

Note:

Like #add, this executes immediately (not deferred) and cascades expiration. Empty input is a no-op returning 0.

Bulk-adds or updates multiple members in a single ZADD.

Mirrors HashKey#update/merge! -- the established Familia pattern for bulk-setting keyed collections. A sorted set is member => score, the same pair shape as HashKey's field => value, so it takes a Hash rather than the variadic splat used by the value-only UnsortedSet/ListKey.

Issues exactly one ZADD instead of one round-trip per member, which is what makes populating a large sorted set fast.

Examples:

board.update("alice" => 1000, "bob" => 850)  #=> 2
board.merge!("alice" => 1200)                 #=> 0 (score updated)

Parameters:

  • hsh (Hash) (defaults to: {}) —

    Mapping of member => score (Object => Numeric)

Returns:

  • (Integer) —

    Number of new members added (members whose score was merely updated are not counted), per redis-rb's bulk ZADD return value

Raises:

  • (ArgumentError) —

    If the argument is not a Hash, or any score is not Numeric



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/familia/data_type/types/sorted_set.rb', line 165

def update(hsh = {})
  warn_if_dirty!
  raise ArgumentError, 'Argument to bulk add must be a hash' unless hsh.is_a?(Hash)
  return 0 if hsh.empty?

  pairs = hsh.map do |member, score|
    unless score.is_a?(Numeric)
      raise ArgumentError, "SortedSet#update score for #{member.inspect} must be Numeric, got #{score.class}"
    end

    [score, serialize_value(member)]
  end
  ret = dbclient.zadd(dbkey, pairs)
  update_expiration
  ret
end