Module: Redis::Commands::SortedSets
- Included in:
- Redis::Commands
- Defined in:
- lib/redis/commands/sorted_sets.rb
Instance Method Summary collapse
-
#bzpopmax(*args) ⇒ Array<String, String, Float>?
Removes and returns up to count members with the highest scores in the sorted set stored at keys, or block until one is available.
-
#bzpopmin(*args) ⇒ Array<String, String, Float>?
Removes and returns up to count members with the lowest scores in the sorted set stored at keys, or block until one is available.
-
#zadd(key, *args, nx: nil, xx: nil, lt: nil, gt: nil, ch: nil, incr: nil) ⇒ Boolean, ...
Add one or more members to a sorted set, or update the score for members that already exist.
-
#zcard(key) ⇒ Integer
Get the number of members in a sorted set.
-
#zcount(key, min, max) ⇒ Integer
Count the members in a sorted set with scores within the given values.
-
#zdiff(*keys, with_scores: false) ⇒ Array<String>, Array<[String, Float]>
Return the difference between the first and all successive input sorted sets.
-
#zdiffstore(*args) ⇒ Integer
Compute the difference between the first and all successive input sorted sets and store the resulting sorted set in a new key.
-
#zincrby(key, increment, member) ⇒ Float
Increment the score of a member in a sorted set.
-
#zinter(*args) ⇒ Array<String>, Array<[String, Float]>
Return the intersection of multiple sorted sets.
-
#zinterstore(*args) ⇒ Integer
Intersect multiple sorted sets and store the resulting sorted set in a new key.
-
#zlexcount(key, min, max) ⇒ Integer
Count the members, with the same score in a sorted set, within the given lexicographical range.
-
#zmscore(key, *members) ⇒ Array<Float>
Get the scores associated with the given members in a sorted set.
-
#zpopmax(key, count = nil) ⇒ Array<String, Float>+
Removes and returns up to count members with the highest scores in the sorted set stored at key.
-
#zpopmin(key, count = nil) ⇒ Array<String, Float>+
Removes and returns up to count members with the lowest scores in the sorted set stored at key.
-
#zrandmember(key, count = nil, withscores: false, with_scores: withscores) ⇒ nil, ...
Get one or more random members from a sorted set.
-
#zrange(key, start, stop, byscore: false, by_score: byscore, bylex: false, by_lex: bylex, rev: false, limit: nil, withscores: false, with_scores: withscores) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by index, score or lexicographical ordering.
-
#zrangebylex(key, min, max, limit: nil) ⇒ Array<String>, Array<[String, Float]>
Return a range of members with the same score in a sorted set, by lexicographical ordering.
-
#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.
-
#zrangestore(dest_key, src_key, start, stop, byscore: false, by_score: byscore, bylex: false, by_lex: bylex, rev: false, limit: nil) ⇒ Integer
Select a range of members in a sorted set, by index, score or lexicographical ordering and store the resulting sorted set in a new key.
-
#zrank(key, member) ⇒ Integer
Determine the index of a member in a sorted set.
-
#zrem(key, member) ⇒ Boolean, Integer
Remove one or more members from a sorted set.
-
#zremrangebyrank(key, start, stop) ⇒ Integer
Remove all members in a sorted set within the given indexes.
-
#zremrangebyscore(key, min, max) ⇒ Integer
Remove all members in a sorted set within the given scores.
-
#zrevrange(key, start, stop, withscores: false, with_scores: withscores) ⇒ Object
Return a range of members in a sorted set, by index, with scores ordered from high to low.
-
#zrevrangebylex(key, max, min, limit: nil) ⇒ Object
Return a range of members with the same score in a sorted set, by reversed lexicographical ordering.
-
#zrevrangebyscore(key, max, min, withscores: false, with_scores: withscores, limit: nil) ⇒ Object
Return a range of members in a sorted set, by score, with scores ordered from high to low.
-
#zrevrank(key, member) ⇒ Integer
Determine the index of a member in a sorted set, with scores ordered from high to low.
-
#zscan(key, cursor, **options) ⇒ String, Array<[String, Float]>
Scan a sorted set.
-
#zscan_each(key, **options, &block) ⇒ Enumerator
Scan a sorted set.
-
#zscore(key, member) ⇒ Float
Get the score associated with the given member in a sorted set.
-
#zunion(*args) ⇒ Array<String>, Array<[String, Float]>
Return the union of multiple sorted sets.
-
#zunionstore(*args) ⇒ Integer
Add multiple sorted sets and store the resulting sorted set in a new key.
Instance Method Details
#bzpopmax(*args) ⇒ Array<String, String, Float>?
Removes and returns up to count members with the highest scores in the sorted set stored at keys,
or block until one is available.
181 182 183 184 185 |
# File 'lib/redis/commands/sorted_sets.rb', line 181 def bzpopmax(*args) _bpop(:bzpopmax, args) do |reply| reply.is_a?(Array) ? [reply[0], reply[1], Floatify.call(reply[2])] : reply end end |
#bzpopmin(*args) ⇒ Array<String, String, Float>?
Removes and returns up to count members with the lowest scores in the sorted set stored at keys,
or block until one is available.
202 203 204 205 206 |
# File 'lib/redis/commands/sorted_sets.rb', line 202 def bzpopmin(*args) _bpop(:bzpopmin, args) do |reply| reply.is_a?(Array) ? [reply[0], reply[1], Floatify.call(reply[2])] : reply end end |
#zadd(key, *args, nx: nil, xx: nil, lt: nil, gt: nil, ch: nil, incr: nil) ⇒ Boolean, ...
Add one or more members to a sorted set, or update the score for members that already exist.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/redis/commands/sorted_sets.rb', line 53 def zadd(key, *args, nx: nil, xx: nil, lt: nil, gt: nil, ch: nil, incr: nil) command = [:zadd, key] command << "NX" if nx command << "XX" if xx command << "LT" if lt command << "GT" if gt command << "CH" if ch command << "INCR" if incr if args.size == 1 && args[0].is_a?(Array) members_to_add = args[0] return 0 if members_to_add.empty? # Variadic: return float if INCR, integer if !INCR send_command(command + members_to_add, &(incr ? Floatify : nil)) elsif args.size == 2 # Single pair: return float if INCR, boolean if !INCR send_command(command + args, &(incr ? Floatify : Boolify)) else raise ArgumentError, "wrong number of arguments" end end |
#zcard(key) ⇒ Integer
Get the number of members in a sorted set.
14 15 16 |
# File 'lib/redis/commands/sorted_sets.rb', line 14 def zcard(key) send_command([:zcard, key]) end |
#zcount(key, min, max) ⇒ Integer
Count the members in a sorted set with scores within the given values.
608 609 610 |
# File 'lib/redis/commands/sorted_sets.rb', line 608 def zcount(key, min, max) send_command([:zcount, key, min, max]) end |
#zdiff(*keys, with_scores: false) ⇒ Array<String>, Array<[String, Float]>
Return the difference between the first and all successive input sorted sets
717 718 719 |
# File 'lib/redis/commands/sorted_sets.rb', line 717 def zdiff(*keys, with_scores: false) _zsets_operation(:zdiff, *keys, with_scores: with_scores) end |
#zdiffstore(*args) ⇒ Integer
Compute the difference between the first and all successive input sorted sets and store the resulting sorted set in a new key
733 734 735 |
# File 'lib/redis/commands/sorted_sets.rb', line 733 def zdiffstore(*args) _zsets_operation_store(:zdiffstore, *args) end |
#zincrby(key, increment, member) ⇒ Float
Increment the score of a member in a sorted set.
86 87 88 |
# File 'lib/redis/commands/sorted_sets.rb', line 86 def zincrby(key, increment, member) send_command([:zincrby, key, increment, member], &Floatify) end |
#zinter(*args) ⇒ Array<String>, Array<[String, Float]>
Return the intersection of multiple sorted sets
631 632 633 |
# File 'lib/redis/commands/sorted_sets.rb', line 631 def zinter(*args) _zsets_operation(:zinter, *args) end |
#zinterstore(*args) ⇒ Integer
Intersect multiple sorted sets and store the resulting sorted set in a new key.
650 651 652 |
# File 'lib/redis/commands/sorted_sets.rb', line 650 def zinterstore(*args) _zsets_operation_store(:zinterstore, *args) end |
#zlexcount(key, min, max) ⇒ Integer
Count the members, with the same score in a sorted set, within the given lexicographical range.
439 440 441 |
# File 'lib/redis/commands/sorted_sets.rb', line 439 def zlexcount(key, min, max) send_command([:zlexcount, key, min, max]) end |
#zmscore(key, *members) ⇒ Array<Float>
Get the scores associated with the given members in a sorted set.
230 231 232 233 234 |
# File 'lib/redis/commands/sorted_sets.rb', line 230 def zmscore(key, *members) send_command([:zmscore, key, *members]) do |reply| reply.map(&Floatify) end end |
#zpopmax(key, count = nil) ⇒ Array<String, Float>+
Removes and returns up to count members with the highest scores in the sorted set stored at key.
138 139 140 141 142 143 |
# File 'lib/redis/commands/sorted_sets.rb', line 138 def zpopmax(key, count = nil) send_command([:zpopmax, key, count].compact) do |members| members = FloatifyPairs.call(members) count.to_i > 1 ? members : members.first end end |
#zpopmin(key, count = nil) ⇒ Array<String, Float>+
Removes and returns up to count members with the lowest scores in the sorted set stored at key.
159 160 161 162 163 164 |
# File 'lib/redis/commands/sorted_sets.rb', line 159 def zpopmin(key, count = nil) send_command([:zpopmin, key, count].compact) do |members| members = FloatifyPairs.call(members) count.to_i > 1 ? members : members.first end end |
#zrandmember(key, count = nil, withscores: false, with_scores: withscores) ⇒ nil, ...
Get one or more random members from a sorted set.
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/redis/commands/sorted_sets.rb', line 258 def zrandmember(key, count = nil, withscores: false, with_scores: withscores) if with_scores && count.nil? raise ArgumentError, "count argument must be specified" end args = [:zrandmember, key] args << count if count if with_scores args << "WITHSCORES" block = FloatifyPairs end send_command(args, &block) end |
#zrange(key, start, stop, byscore: false, by_score: byscore, bylex: false, by_lex: bylex, rev: false, limit: nil, withscores: false, with_scores: withscores) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by index, score or lexicographical ordering.
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/redis/commands/sorted_sets.rb', line 297 def zrange(key, start, stop, byscore: false, by_score: byscore, bylex: false, by_lex: bylex, rev: false, limit: nil, withscores: false, with_scores: withscores) if by_score && by_lex raise ArgumentError, "only one of :by_score or :by_lex can be specified" end args = [:zrange, key, start, stop] if by_score args << "BYSCORE" elsif by_lex args << "BYLEX" end args << "REV" if rev if limit args << "LIMIT" args.concat(limit) end if with_scores args << "WITHSCORES" block = FloatifyPairs end send_command(args, &block) end |
#zrangebylex(key, min, max, limit: nil) ⇒ Array<String>, Array<[String, Float]>
Return a range of members with the same score in a sorted set, by lexicographical ordering
464 465 466 467 468 469 470 471 472 473 |
# File 'lib/redis/commands/sorted_sets.rb', line 464 def zrangebylex(key, min, max, limit: nil) args = [:zrangebylex, key, min, max] if limit args << "LIMIT" args.concat(limit) end send_command(args) end |
#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.
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 |
# File 'lib/redis/commands/sorted_sets.rb', line 524 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) end send_command(args, &block) end |
#zrangestore(dest_key, src_key, start, stop, byscore: false, by_score: byscore, bylex: false, by_lex: bylex, rev: false, limit: nil) ⇒ Integer
Select a range of members in a sorted set, by index, score or lexicographical ordering and store the resulting sorted set in a new key.
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/redis/commands/sorted_sets.rb', line 339 def zrangestore(dest_key, src_key, start, stop, byscore: false, by_score: byscore, bylex: false, by_lex: bylex, rev: false, limit: nil) if by_score && by_lex raise ArgumentError, "only one of :by_score or :by_lex can be specified" end args = [:zrangestore, dest_key, src_key, start, stop] if by_score args << "BYSCORE" elsif by_lex args << "BYLEX" end args << "REV" if rev if limit args << "LIMIT" args.concat(limit) end send_command(args) end |
#zrank(key, member) ⇒ Integer
Determine the index of a member in a sorted set.
390 391 392 |
# File 'lib/redis/commands/sorted_sets.rb', line 390 def zrank(key, member) send_command([:zrank, key, member]) end |
#zrem(key, member) ⇒ Boolean, Integer
Remove one or more members from a sorted set.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/redis/commands/sorted_sets.rb', line 107 def zrem(key, member) if member.is_a?(Array) members_to_remove = member return 0 if members_to_remove.empty? end send_command([:zrem, key, member]) do |reply| if member.is_a? Array # Variadic: return integer reply else # Single argument: return boolean Boolify.call(reply) end end end |
#zremrangebyrank(key, start, stop) ⇒ Integer
Remove all members in a sorted set within the given indexes.
417 418 419 |
# File 'lib/redis/commands/sorted_sets.rb', line 417 def zremrangebyrank(key, start, stop) send_command([:zremrangebyrank, key, start, stop]) end |
#zremrangebyscore(key, min, max) ⇒ Integer
Remove all members in a sorted set within the given scores.
587 588 589 |
# File 'lib/redis/commands/sorted_sets.rb', line 587 def zremrangebyscore(key, min, max) send_command([:zremrangebyscore, key, min, max]) end |
#zrevrange(key, start, stop, withscores: false, with_scores: withscores) ⇒ Object
Return a range of members in a sorted set, by index, with scores ordered from high to low.
374 375 376 377 378 379 380 381 382 383 |
# File 'lib/redis/commands/sorted_sets.rb', line 374 def zrevrange(key, start, stop, withscores: false, with_scores: withscores) args = [:zrevrange, key, start, stop] if with_scores args << "WITHSCORES" block = FloatifyPairs end send_command(args, &block) end |
#zrevrangebylex(key, max, min, limit: nil) ⇒ Object
Return a range of members with the same score in a sorted set, by reversed lexicographical ordering. Apart from the reversed ordering, #zrevrangebylex is similar to #zrangebylex.
486 487 488 489 490 491 492 493 494 495 |
# File 'lib/redis/commands/sorted_sets.rb', line 486 def zrevrangebylex(key, max, min, limit: nil) args = [:zrevrangebylex, key, max, min] if limit args << "LIMIT" args.concat(limit) end send_command(args) end |
#zrevrangebyscore(key, max, min, withscores: false, with_scores: withscores, limit: nil) ⇒ Object
Return a range of members in a sorted set, by score, with scores ordered from high to low.
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 |
# File 'lib/redis/commands/sorted_sets.rb', line 554 def zrevrangebyscore(key, max, min, withscores: false, with_scores: withscores, limit: nil) args = [:zrevrangebyscore, key, max, min] if with_scores args << "WITHSCORES" block = FloatifyPairs end if limit args << "LIMIT" args.concat(limit) end send_command(args, &block) end |
#zrevrank(key, member) ⇒ Integer
Determine the index of a member in a sorted set, with scores ordered from high to low.
400 401 402 |
# File 'lib/redis/commands/sorted_sets.rb', line 400 def zrevrank(key, member) send_command([:zrevrank, key, member]) end |
#zscan(key, cursor, **options) ⇒ String, Array<[String, Float]>
Scan a sorted set
750 751 752 753 754 |
# File 'lib/redis/commands/sorted_sets.rb', line 750 def zscan(key, cursor, **) _scan(:zscan, cursor, [key], **) do |reply| [reply[0], FloatifyPairs.call(reply[1])] end end |
#zscan_each(key, **options, &block) ⇒ Enumerator
Scan a sorted set
767 768 769 770 771 772 773 774 775 776 |
# File 'lib/redis/commands/sorted_sets.rb', line 767 def zscan_each(key, **, &block) return to_enum(:zscan_each, key, **) unless block_given? cursor = 0 loop do cursor, values = zscan(key, cursor, **) values.each(&block) break if cursor == "0" end end |
#zscore(key, member) ⇒ Float
Get the score associated with the given member in a sorted set.
217 218 219 |
# File 'lib/redis/commands/sorted_sets.rb', line 217 def zscore(key, member) send_command([:zscore, key, member], &Floatify) end |
#zunion(*args) ⇒ Array<String>, Array<[String, Float]>
Return the union of multiple sorted sets
674 675 676 |
# File 'lib/redis/commands/sorted_sets.rb', line 674 def zunion(*args) _zsets_operation(:zunion, *args) end |
#zunionstore(*args) ⇒ Integer
Add multiple sorted sets and store the resulting sorted set in a new key.
692 693 694 |
# File 'lib/redis/commands/sorted_sets.rb', line 692 def zunionstore(*args) _zsets_operation_store(:zunionstore, *args) end |