Class: Redis
- Inherits:
-
Object
- Object
- Redis
- Includes:
- MonitorMixin
- Defined in:
- lib/redis.rb,
lib/redis/client.rb,
lib/redis/errors.rb,
lib/redis/cluster.rb,
lib/redis/version.rb,
lib/redis/pipeline.rb,
lib/redis/hash_ring.rb,
lib/redis/subscribe.rb,
lib/redis/distributed.rb,
lib/redis/cluster/node.rb,
lib/redis/cluster/slot.rb,
lib/redis/cluster/option.rb,
lib/redis/cluster/command.rb,
lib/redis/connection/ruby.rb,
lib/redis/cluster/node_key.rb,
lib/redis/connection/hiredis.rb,
lib/redis/cluster/node_loader.rb,
lib/redis/cluster/slot_loader.rb,
lib/redis/connection/registry.rb,
lib/redis/connection/synchrony.rb,
lib/redis/cluster/command_loader.rb,
lib/redis/connection/command_helper.rb,
lib/redis/cluster/key_slot_converter.rb
Defined Under Namespace
Modules: Connection Classes: BaseConnectionError, BaseError, CannotConnectError, Client, Cluster, CommandError, ConnectionError, Distributed, Future, FutureNotReady, HashRing, InheritedError, InvalidClientOptionError, Pipeline, ProtocolError, SubscribedClient, Subscription, TimeoutError
Constant Summary collapse
- VERSION =
'4.3.1'
Class Attribute Summary collapse
- .current ⇒ Object
-
.exists_returns_integer ⇒ Object
Returns the value of attribute exists_returns_integer.
Instance Method Summary collapse
- #_bpop(cmd, args, &blk) ⇒ Object
- #_client ⇒ Object
- #_eval(cmd, args) ⇒ Object
- #_exists(*keys) ⇒ Object
- #_scan(command, cursor, args, match: nil, count: nil, type: nil, &block) ⇒ Object
-
#append(key, value) ⇒ Integer
Append a value to a key.
-
#asking ⇒ String
Sends ‘ASKING` command to random node and returns its reply.
-
#auth(*args) ⇒ String
Authenticate to the server.
-
#bgrewriteaof ⇒ String
Asynchronously rewrite the append-only file.
-
#bgsave ⇒ String
Asynchronously save the dataset to disk.
-
#bitcount(key, start = 0, stop = -1)) ⇒ Integer
Count the number of set bits in a range of the string value stored at key.
-
#bitop(operation, destkey, *keys) ⇒ Integer
Perform a bitwise operation between strings and store the resulting string in a key.
-
#bitpos(key, bit, start = nil, stop = nil) ⇒ Integer
Return the position of the first bit set to 1 or 0 in a string.
-
#blpop(*args) ⇒ nil, [String, String]
Remove and get the first element in a list, or block until one is available.
-
#brpop(*args) ⇒ nil, [String, String]
Remove and get the last element in a list, or block until one is available.
-
#brpoplpush(source, destination, deprecated_timeout = 0, timeout: deprecated_timeout) ⇒ nil, String
Pop a value from a list, push it to another list and return it; or block until one is available.
-
#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.
-
#call(*command) ⇒ Object
Sends a command to Redis and returns its reply.
-
#client(subcommand = nil, *args) ⇒ String, Hash
Manage client connections.
-
#close ⇒ Object
(also: #disconnect!)
Disconnect the client as quickly and silently as possible.
-
#cluster(subcommand, *args) ⇒ Object
Sends ‘CLUSTER *` command to random node and returns its reply.
-
#commit ⇒ Object
Sends all commands in the queue.
-
#config(action, *args) ⇒ String, Hash
Get or set server configuration parameters.
-
#connected? ⇒ Boolean
Test whether or not the client is connected.
- #connection ⇒ Object
-
#dbsize ⇒ Integer
Return the number of keys in the selected database.
- #debug(*args) ⇒ Object
-
#decr(key) ⇒ Integer
Decrement the integer value of a key by one.
-
#decrby(key, decrement) ⇒ Integer
Decrement the integer value of a key by the given number.
-
#del(*keys) ⇒ Integer
Delete one or more keys.
-
#discard ⇒ String
Discard all commands issued after MULTI.
-
#dump(key) ⇒ String
Return a serialized version of the value stored at a key.
- #dup ⇒ Object
-
#echo(value) ⇒ String
Echo the given string.
-
#eval(*args) ⇒ Object
Evaluate Lua script.
-
#evalsha(*args) ⇒ Object
Evaluate Lua script by its SHA.
-
#exec ⇒ nil, Array<...>
Execute all commands issued after MULTI.
-
#exists(*keys) ⇒ Integer
Determine how many of the keys exists.
-
#exists?(*keys) ⇒ Boolean
Determine if any of the keys exists.
-
#expire(key, seconds) ⇒ Boolean
Set a key’s time to live in seconds.
-
#expireat(key, unix_time) ⇒ Boolean
Set the expiration for a key as a UNIX timestamp.
-
#flushall(options = nil) ⇒ String
Remove all keys from all databases.
-
#flushdb(options = nil) ⇒ String
Remove all keys from the current database.
-
#geoadd(key, *member) ⇒ Integer
Adds the specified geospatial items (latitude, longitude, name) to the specified key.
-
#geodist(key, member1, member2, unit = 'm') ⇒ String?
Returns the distance between two members of a geospatial index.
-
#geohash(key, member) ⇒ Array<String, nil>
Returns geohash string representing position for specified members of the specified key.
-
#geopos(key, member) ⇒ Array<Array<String>, nil>
Returns longitude and latitude of members of a geospatial index.
-
#georadius(*args, **geoptions) ⇒ Array<String>
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point.
-
#georadiusbymember(*args, **geoptions) ⇒ Array<String>
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from an already existing member.
-
#get(key) ⇒ String
Get the value of a key.
-
#getbit(key, offset) ⇒ Integer
Returns the bit value at offset in the string value stored at key.
-
#getrange(key, start, stop) ⇒ Integer
Get a substring of the string stored at a key.
-
#getset(key, value) ⇒ String
Set the string value of a key and return its old value.
-
#hdel(key, *fields) ⇒ Integer
Delete one or more hash fields.
-
#hexists(key, field) ⇒ Boolean
Determine if a hash field exists.
-
#hget(key, field) ⇒ String
Get the value of a hash field.
-
#hgetall(key) ⇒ Hash<String, String>
Get all the fields and values in a hash.
-
#hincrby(key, field, increment) ⇒ Integer
Increment the integer value of a hash field by the given integer number.
-
#hincrbyfloat(key, field, increment) ⇒ Float
Increment the numeric value of a hash field by the given float number.
-
#hkeys(key) ⇒ Array<String>
Get all the fields in a hash.
-
#hlen(key) ⇒ Integer
Get the number of fields in a hash.
-
#hmget(key, *fields, &blk) ⇒ Array<String>
Get the values of all the given hash fields.
-
#hmset(key, *attrs) ⇒ String
Set one or more hash values.
-
#hscan(key, cursor, **options) ⇒ String, Array<[String, String]>
Scan a hash.
-
#hscan_each(key, **options, &block) ⇒ Enumerator
Scan a hash.
-
#hset(key, *attrs) ⇒ Integer
Set one or more hash values.
-
#hsetnx(key, field, value) ⇒ Boolean
Set the value of a hash field, only if the field does not exist.
-
#hvals(key) ⇒ Array<String>
Get all the values in a hash.
- #id ⇒ Object
-
#incr(key) ⇒ Integer
Increment the integer value of a key by one.
-
#incrby(key, increment) ⇒ Integer
Increment the integer value of a key by the given integer number.
-
#incrbyfloat(key, increment) ⇒ Float
Increment the numeric value of a key by the given float number.
-
#info(cmd = nil) ⇒ Hash<String, String>
Get information and statistics about the server.
-
#initialize(options = {}) ⇒ Redis
constructor
Create a new client instance.
- #inspect ⇒ Object
-
#keys(pattern = "*") ⇒ Array<String>
Find all keys matching the given pattern.
-
#lastsave ⇒ Integer
Get the UNIX time stamp of the last successful save to disk.
-
#lindex(key, index) ⇒ String
Get an element from a list by its index.
-
#linsert(key, where, pivot, value) ⇒ Integer
Insert an element before or after another element in a list.
-
#llen(key) ⇒ Integer
Get the length of a list.
-
#lpop(key, count = nil) ⇒ String+
Remove and get the first elements in a list.
-
#lpush(key, value) ⇒ Integer
Prepend one or more values to a list, creating the list if it doesn’t exist.
-
#lpushx(key, value) ⇒ Integer
Prepend a value to a list, only if the list exists.
-
#lrange(key, start, stop) ⇒ Array<String>
Get a range of elements from a list.
-
#lrem(key, count, value) ⇒ Integer
Remove elements from a list.
-
#lset(key, index, value) ⇒ String
Set the value of an element in a list by its index.
-
#ltrim(key, start, stop) ⇒ String
Trim a list to the specified range.
-
#mapped_hmget(key, *fields) ⇒ Hash
Get the values of all the given hash fields.
-
#mapped_hmset(key, hash) ⇒ String
Set one or more hash values.
-
#mapped_mget(*keys) ⇒ Hash
Get the values of all the given keys.
-
#mapped_mset(hash) ⇒ String
Set one or more values.
-
#mapped_msetnx(hash) ⇒ Boolean
Set one or more values, only if none of the keys exist.
-
#method_missing(command, *args) ⇒ Object
rubocop:disable Style/MissingRespondToMissing.
-
#mget(*keys, &blk) ⇒ Array<String>
Get the values of all the given keys.
-
#migrate(key, options) ⇒ String
Transfer a key from the connected instance to another instance.
-
#monitor {|line| ... } ⇒ Object
Listen for all requests received by the server in real time.
-
#move(key, db) ⇒ Boolean
Move a key to another database.
-
#mset(*args) ⇒ String
Set one or more values.
-
#msetnx(*args) ⇒ Boolean
Set one or more values, only if none of the keys exist.
-
#multi {|multi| ... } ⇒ String, Array<...>
Mark the start of a transaction block.
- #object(*args) ⇒ Object
-
#persist(key) ⇒ Boolean
Remove the expiration from a key.
-
#pexpire(key, milliseconds) ⇒ Boolean
Set a key’s time to live in milliseconds.
-
#pexpireat(key, ms_unix_time) ⇒ Boolean
Set the expiration for a key as number of milliseconds from UNIX Epoch.
-
#pfadd(key, member) ⇒ Boolean
Add one or more members to a HyperLogLog structure.
-
#pfcount(*keys) ⇒ Integer
Get the approximate cardinality of members added to HyperLogLog structure.
-
#pfmerge(dest_key, *source_key) ⇒ Boolean
Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
-
#ping(message = nil) ⇒ String
Ping the server.
- #pipelined ⇒ Object
-
#psetex(key, ttl, value) ⇒ String
Set the time to live in milliseconds of a key.
-
#psubscribe(*channels, &block) ⇒ Object
Listen for messages published to channels matching the given patterns.
-
#psubscribe_with_timeout(timeout, *channels, &block) ⇒ Object
Listen for messages published to channels matching the given patterns.
-
#pttl(key) ⇒ Integer
Get the time to live (in milliseconds) for a key.
-
#publish(channel, message) ⇒ Object
Post a message to a channel.
-
#pubsub(subcommand, *args) ⇒ Object
Inspect the state of the Pub/Sub subsystem.
-
#punsubscribe(*channels) ⇒ Object
Stop listening for messages posted to channels matching the given patterns.
-
#queue(*command) ⇒ Object
Queues a command for pipelining.
-
#quit ⇒ String
Close the connection.
-
#randomkey ⇒ String
Return a random key from the keyspace.
-
#rename(old_name, new_name) ⇒ String
Rename a key.
-
#renamenx(old_name, new_name) ⇒ Boolean
Rename a key, only if the new key does not exist.
-
#restore(key, ttl, serialized_value, replace: nil) ⇒ String
Create a key using the serialized value, previously obtained using DUMP.
-
#rpop(key, count = nil) ⇒ String+
Remove and get the last elements in a list.
-
#rpoplpush(source, destination) ⇒ nil, String
Remove the last element in a list, append it to another list and return it.
-
#rpush(key, value) ⇒ Integer
Append one or more values to a list, creating the list if it doesn’t exist.
-
#rpushx(key, value) ⇒ Integer
Append a value to a list, only if the list exists.
-
#sadd(key, member) ⇒ Boolean, Integer
Add one or more members to a set.
-
#save ⇒ String
Synchronously save the dataset to disk.
-
#scan(cursor, **options) ⇒ String+
Scan the keyspace.
-
#scan_each(**options, &block) ⇒ Enumerator
Scan the keyspace.
-
#scard(key) ⇒ Integer
Get the number of members in a set.
-
#script(subcommand, *args) ⇒ String, ...
Control remote script registry.
-
#sdiff(*keys) ⇒ Array<String>
Subtract multiple sets.
-
#sdiffstore(destination, *keys) ⇒ Integer
Subtract multiple sets and store the resulting set in a key.
-
#select(db) ⇒ String
Change the selected database for the current connection.
-
#sentinel(subcommand, *args) ⇒ Array<String>, ...
Interact with the sentinel command (masters, master, slaves, failover).
-
#set(key, value, ex: nil, px: nil, nx: nil, xx: nil, keepttl: nil) ⇒ String, Boolean
Set the string value of a key.
-
#setbit(key, offset, value) ⇒ Integer
Sets or clears the bit at offset in the string value stored at key.
-
#setex(key, ttl, value) ⇒ String
Set the time to live in seconds of a key.
-
#setnx(key, value) ⇒ Boolean
Set the value of a key, only if the key does not exist.
-
#setrange(key, offset, value) ⇒ Integer
Overwrite part of a string at key starting at the specified offset.
-
#shutdown ⇒ Object
Synchronously save the dataset to disk and then shut down the server.
-
#sinter(*keys) ⇒ Array<String>
Intersect multiple sets.
-
#sinterstore(destination, *keys) ⇒ Integer
Intersect multiple sets and store the resulting set in a key.
-
#sismember(key, member) ⇒ Boolean
Determine if a given value is a member of a set.
-
#slaveof(host, port) ⇒ Object
Make the server a slave of another instance, or promote it as master.
-
#slowlog(subcommand, length = nil) ⇒ Array<String>, ...
Interact with the slowlog (get, len, reset).
-
#smembers(key) ⇒ Array<String>
Get all the members in a set.
-
#smove(source, destination, member) ⇒ Boolean
Move a member from one set to another.
-
#sort(key, by: nil, limit: nil, get: nil, order: nil, store: nil) ⇒ Array<String>, ...
Sort the elements in a list, set or sorted set.
-
#spop(key, count = nil) ⇒ String
Remove and return one or more random member from a set.
-
#srandmember(key, count = nil) ⇒ String
Get one or more random members from a set.
-
#srem(key, member) ⇒ Boolean, Integer
Remove one or more members from a set.
-
#sscan(key, cursor, **options) ⇒ String+
Scan a set.
-
#sscan_each(key, **options, &block) ⇒ Enumerator
Scan a set.
-
#strlen(key) ⇒ Integer
Get the length of the value stored in a key.
-
#subscribe(*channels, &block) ⇒ Object
Listen for messages published to the given channels.
-
#subscribe_with_timeout(timeout, *channels, &block) ⇒ Object
Listen for messages published to the given channels.
- #subscribed? ⇒ Boolean
-
#sunion(*keys) ⇒ Array<String>
Add multiple sets.
-
#sunionstore(destination, *keys) ⇒ Integer
Add multiple sets and store the resulting set in a key.
-
#sync ⇒ Object
Internal command used for replication.
- #synchronize ⇒ Object
-
#time ⇒ Array<Integer>
Return the server time.
-
#ttl(key) ⇒ Integer
Get the time to live (in seconds) for a key.
-
#type(key) ⇒ String
Determine the type stored at key.
-
#unlink(*keys) ⇒ Integer
Unlink one or more keys.
-
#unsubscribe(*channels) ⇒ Object
Stop listening for messages posted to the given channels.
-
#unwatch ⇒ String
Forget about all watched keys.
-
#watch(*keys) ⇒ Object, String
Watch the given keys to determine execution of the MULTI/EXEC block.
-
#with_reconnect(val = true, &blk) ⇒ Object
Run code with the client reconnecting.
-
#without_reconnect(&blk) ⇒ Object
Run code without the client reconnecting.
-
#xack(key, group, *ids) ⇒ Integer
Removes one or multiple entries from the pending entries list of a stream consumer group.
-
#xadd(key, entry, approximate: nil, maxlen: nil, id: '*') ⇒ String
Add new entry to the stream.
-
#xclaim(key, group, consumer, min_idle_time, *ids, **opts) ⇒ Hash{String => Hash}, Array<String>
Changes the ownership of a pending entry.
-
#xdel(key, *ids) ⇒ Integer
Delete entries by entry ids.
-
#xgroup(subcommand, key, group, id_or_consumer = nil, mkstream: false) ⇒ String, Integer
Manages the consumer group of the stream.
-
#xinfo(subcommand, key, group = nil) ⇒ Hash+
Returns the stream information each subcommand.
-
#xlen(key) ⇒ Integer
Returns the number of entries inside a stream.
-
#xpending(key, group, *args) ⇒ Hash+
Fetches not acknowledging pending entries.
-
#xrange(key, start = '-', range_end = '+', count: nil) ⇒ Array<Array<String, Hash>>
Fetches entries of the stream in ascending order.
-
#xread(keys, ids, count: nil, block: nil) ⇒ Hash{String => Hash{String => Hash}}
Fetches entries from one or multiple streams.
-
#xreadgroup(group, consumer, keys, ids, count: nil, block: nil, noack: nil) ⇒ Hash{String => Hash{String => Hash}}
Fetches a subset of the entries from one or multiple streams related with the consumer group.
-
#xrevrange(key, range_end = '+', start = '-', count: nil) ⇒ Array<Array<String, Hash>>
Fetches entries of the stream in descending order.
-
#xtrim(key, maxlen, approximate: false) ⇒ Integer
Trims older entries of the stream if needed.
-
#zadd(key, *args, nx: nil, xx: 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.
-
#zincrby(key, increment, member) ⇒ Float
Increment the score of a member in a sorted set.
-
#zinterstore(destination, keys, weights: nil, aggregate: nil) ⇒ 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.
-
#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.
-
#zrange(key, start, stop, withscores: false, with_scores: withscores) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by index.
-
#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.
-
#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.
-
#zunionstore(destination, keys, weights: nil, aggregate: nil) ⇒ Integer
Add multiple sorted sets and store the resulting sorted set in a new key.
Constructor Details
#initialize(options = {}) ⇒ Redis
Create a new client instance
59 60 61 62 63 64 65 66 67 |
# File 'lib/redis.rb', line 59 def initialize( = {}) @options = .dup @cluster_mode = .key?(:cluster) client = @cluster_mode ? Cluster : Client @original_client = @client = client.new() @queue = Hash.new { |h, k| h[k] = [] } super() # Monitor#initialize end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(command, *args) ⇒ Object
rubocop:disable Style/MissingRespondToMissing
3364 3365 3366 3367 3368 |
# File 'lib/redis.rb', line 3364 def method_missing(command, *args) # rubocop:disable Style/MissingRespondToMissing synchronize do |client| client.call([command] + args) end end |
Class Attribute Details
.current ⇒ Object
25 26 27 |
# File 'lib/redis.rb', line 25 def self.current @current ||= Redis.new end |
.exists_returns_integer ⇒ Object
Returns the value of attribute exists_returns_integer.
8 9 10 |
# File 'lib/redis.rb', line 8 def exists_returns_integer @exists_returns_integer end |
Instance Method Details
#_bpop(cmd, args, &blk) ⇒ Object
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 |
# File 'lib/redis.rb', line 1212 def _bpop(cmd, args, &blk) timeout = if args.last.is_a?(Hash) = args.pop [:timeout] elsif args.last.respond_to?(:to_int) # Issue deprecation notice in obnoxious mode... args.pop.to_int end timeout ||= 0 if args.size > 1 # Issue deprecation notice in obnoxious mode... end keys = args.flatten synchronize do |client| command = [cmd, keys, timeout] timeout += client.timeout if timeout > 0 client.call_with_timeout(command, timeout, &blk) end end |
#_client ⇒ Object
141 142 143 |
# File 'lib/redis.rb', line 141 def _client @client end |
#_eval(cmd, args) ⇒ Object
2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 |
# File 'lib/redis.rb', line 2584 def _eval(cmd, args) script = args.shift = args.pop if args.last.is_a?(Hash) ||= {} keys = args.shift || [:keys] || [] argv = args.shift || [:argv] || [] synchronize do |client| client.call([cmd, script, keys.length] + keys + argv) end end |
#_exists(*keys) ⇒ Object
595 596 597 598 599 |
# File 'lib/redis.rb', line 595 def _exists(*keys) synchronize do |client| client.call([:exists, *keys]) end end |
#_scan(command, cursor, args, match: nil, count: nil, type: nil, &block) ⇒ Object
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 |
# File 'lib/redis.rb', line 2647 def _scan(command, cursor, args, match: nil, count: nil, type: nil, &block) # SSCAN/ZSCAN/HSCAN already prepend the key to +args+. args << cursor args << "MATCH" << match if match args << "COUNT" << count if count args << "TYPE" << type if type synchronize do |client| client.call([command] + args, &block) end end |
#append(key, value) ⇒ Integer
Append a value to a key.
1049 1050 1051 1052 1053 |
# File 'lib/redis.rb', line 1049 def append(key, value) synchronize do |client| client.call([:append, key, value]) end end |
#asking ⇒ String
Sends ‘ASKING` command to random node and returns its reply.
3336 3337 3338 |
# File 'lib/redis.rb', line 3336 def asking synchronize { |client| client.call(%i[asking]) } end |
#auth(*args) ⇒ String
Authenticate to the server.
151 152 153 154 155 |
# File 'lib/redis.rb', line 151 def auth(*args) synchronize do |client| client.call([:auth, *args]) end end |
#bgrewriteaof ⇒ String
Asynchronously rewrite the append-only file.
205 206 207 208 209 |
# File 'lib/redis.rb', line 205 def bgrewriteaof synchronize do |client| client.call([:bgrewriteaof]) end end |
#bgsave ⇒ String
Asynchronously save the dataset to disk.
214 215 216 217 218 |
# File 'lib/redis.rb', line 214 def bgsave synchronize do |client| client.call([:bgsave]) end end |
#bitcount(key, start = 0, stop = -1)) ⇒ Integer
Count the number of set bits in a range of the string value stored at key.
1061 1062 1063 1064 1065 |
# File 'lib/redis.rb', line 1061 def bitcount(key, start = 0, stop = -1) synchronize do |client| client.call([:bitcount, key, start, stop]) end end |
#bitop(operation, destkey, *keys) ⇒ Integer
Perform a bitwise operation between strings and store the resulting string in a key.
1073 1074 1075 1076 1077 |
# File 'lib/redis.rb', line 1073 def bitop(operation, destkey, *keys) synchronize do |client| client.call([:bitop, operation, destkey, *keys]) end end |
#bitpos(key, bit, start = nil, stop = nil) ⇒ Integer
Return the position of the first bit set to 1 or 0 in a string.
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 |
# File 'lib/redis.rb', line 1087 def bitpos(key, bit, start = nil, stop = nil) raise(ArgumentError, 'stop parameter specified without start parameter') if stop && !start synchronize do |client| command = [:bitpos, key, bit] command << start if start command << stop if stop client.call(command) end end |
#blpop(*args) ⇒ nil, [String, String]
Remove and get the first element in a list, or block until one is available.
1257 1258 1259 |
# File 'lib/redis.rb', line 1257 def blpop(*args) _bpop(:blpop, args) end |
#brpop(*args) ⇒ nil, [String, String]
Remove and get the last element in a list, or block until one is available.
1273 1274 1275 |
# File 'lib/redis.rb', line 1273 def brpop(*args) _bpop(:brpop, args) end |
#brpoplpush(source, destination, deprecated_timeout = 0, timeout: deprecated_timeout) ⇒ nil, String
Pop a value from a list, push it to another list and return it; or block until one is available.
1288 1289 1290 1291 1292 1293 1294 |
# File 'lib/redis.rb', line 1288 def brpoplpush(source, destination, deprecated_timeout = 0, timeout: deprecated_timeout) synchronize do |client| command = [:brpoplpush, source, destination, timeout] timeout += client.timeout if timeout > 0 client.call_with_timeout(command, timeout) end end |
#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.
1721 1722 1723 1724 1725 |
# File 'lib/redis.rb', line 1721 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.
1742 1743 1744 1745 1746 |
# File 'lib/redis.rb', line 1742 def bzpopmin(*args) _bpop(:bzpopmin, args) do |reply| reply.is_a?(Array) ? [reply[0], reply[1], Floatify.call(reply[2])] : reply end end |
#call(*command) ⇒ Object
Sends a command to Redis and returns its reply.
Replies are converted to Ruby objects according to the RESP protocol, so you can expect a Ruby array, integer or nil when Redis sends one. Higher level transformations, such as converting an array of pairs into a Ruby hash, are up to consumers.
Redis error replies are raised as Ruby exceptions.
104 105 106 107 108 |
# File 'lib/redis.rb', line 104 def call(*command) synchronize do |client| client.call(command) end end |
#client(subcommand = nil, *args) ⇒ String, Hash
Manage client connections.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/redis.rb', line 241 def client(subcommand = nil, *args) synchronize do |client| client.call([:client, subcommand] + args) do |reply| if subcommand.to_s == "list" reply.lines.map do |line| entries = line.chomp.split(/[ =]/) Hash[entries.each_slice(2).to_a] end else reply end end end end |
#close ⇒ Object Also known as: disconnect!
Disconnect the client as quickly and silently as possible.
91 92 93 |
# File 'lib/redis.rb', line 91 def close @original_client.disconnect end |
#cluster(subcommand, *args) ⇒ Object
Sends ‘CLUSTER *` command to random node and returns its reply.
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 |
# File 'lib/redis.rb', line 3308 def cluster(subcommand, *args) subcommand = subcommand.to_s.downcase block = case subcommand when 'slots' HashifyClusterSlots when 'nodes' HashifyClusterNodes when 'slaves' HashifyClusterSlaves when 'info' HashifyInfo else Noop end # @see https://github.com/antirez/redis/blob/unstable/src/redis-trib.rb#L127 raw reply expected block = Noop unless @cluster_mode synchronize do |client| client.call([:cluster, subcommand] + args, &block) end end |
#commit ⇒ Object
Sends all commands in the queue.
See redis.io/topics/pipelining for more details.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/redis.rb', line 126 def commit synchronize do |client| begin pipeline = Pipeline.new(client) @queue[Thread.current.object_id].each do |command| pipeline.call(command) end client.call_pipelined(pipeline) ensure @queue.delete(Thread.current.object_id) end end end |
#config(action, *args) ⇒ String, Hash
Get or set server configuration parameters.
225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/redis.rb', line 225 def config(action, *args) synchronize do |client| client.call([:config, action] + args) do |reply| if reply.is_a?(Array) && action == :get Hashify.call(reply) else reply end end end end |
#connected? ⇒ Boolean
Test whether or not the client is connected
86 87 88 |
# File 'lib/redis.rb', line 86 def connected? @original_client.connected? end |
#connection ⇒ Object
3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 |
# File 'lib/redis.rb', line 3352 def connection return @original_client.connection_info if @cluster_mode { host: @original_client.host, port: @original_client.port, db: @original_client.db, id: @original_client.id, location: @original_client.location } end |
#dbsize ⇒ Integer
Return the number of keys in the selected database.
259 260 261 262 263 |
# File 'lib/redis.rb', line 259 def dbsize synchronize do |client| client.call([:dbsize]) end end |
#debug(*args) ⇒ Object
265 266 267 268 269 |
# File 'lib/redis.rb', line 265 def debug(*args) synchronize do |client| client.call([:debug] + args) end end |
#decr(key) ⇒ Integer
Decrement the integer value of a key by one.
762 763 764 765 766 |
# File 'lib/redis.rb', line 762 def decr(key) synchronize do |client| client.call([:decr, key]) end end |
#decrby(key, decrement) ⇒ Integer
Decrement the integer value of a key by the given number.
777 778 779 780 781 |
# File 'lib/redis.rb', line 777 def decrby(key, decrement) synchronize do |client| client.call([:decrby, key, decrement]) end end |
#del(*keys) ⇒ Integer
Delete one or more keys.
557 558 559 560 561 |
# File 'lib/redis.rb', line 557 def del(*keys) synchronize do |client| client.call([:del] + keys) end end |
#discard ⇒ String
Discard all commands issued after MULTI.
Only call this method when ‘#multi` was called without a block.
2530 2531 2532 2533 2534 |
# File 'lib/redis.rb', line 2530 def discard synchronize do |client| client.call([:discard]) end end |
#dump(key) ⇒ String
Return a serialized version of the value stored at a key.
504 505 506 507 508 |
# File 'lib/redis.rb', line 504 def dump(key) synchronize do |client| client.call([:dump, key]) end end |
#dup ⇒ Object
3348 3349 3350 |
# File 'lib/redis.rb', line 3348 def dup self.class.new(@options) end |
#echo(value) ⇒ String
Echo the given string.
182 183 184 185 186 |
# File 'lib/redis.rb', line 182 def echo(value) synchronize do |client| client.call([:echo, value]) end end |
#eval(*args) ⇒ Object
Evaluate Lua script.
2618 2619 2620 |
# File 'lib/redis.rb', line 2618 def eval(*args) _eval(:eval, args) end |
#evalsha(*args) ⇒ Object
Evaluate Lua script by its SHA.
2643 2644 2645 |
# File 'lib/redis.rb', line 2643 def evalsha(*args) _eval(:evalsha, args) end |
#exec ⇒ nil, Array<...>
Execute all commands issued after MULTI.
Only call this method when ‘#multi` was called without a block.
2516 2517 2518 2519 2520 |
# File 'lib/redis.rb', line 2516 def exec synchronize do |client| client.call([:exec]) end end |
#exists(*keys) ⇒ Integer
Determine how many of the keys exists.
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/redis.rb', line 577 def exists(*keys) if !Redis.exists_returns_integer && keys.size == 1 if Redis.exists_returns_integer.nil? = "`Redis#exists(key)` will return an Integer in redis-rb 4.3. `exists?` returns a boolean, you " \ "should use it instead. To opt-in to the new behavior now you can set Redis.exists_returns_integer = " \ "true. To disable this message and keep the current (boolean) behaviour of 'exists' you can set " \ "`Redis.exists_returns_integer = false`, but this option will be removed in 5.0. " \ "(#{::Kernel.caller(1, 1).first})\n" ::Kernel.warn() end exists?(*keys) else _exists(*keys) end end |
#exists?(*keys) ⇒ Boolean
Determine if any of the keys exists.
605 606 607 608 609 610 611 |
# File 'lib/redis.rb', line 605 def exists?(*keys) synchronize do |client| client.call([:exists, *keys]) do |value| value > 0 end end end |
#expire(key, seconds) ⇒ Boolean
Set a key’s time to live in seconds.
426 427 428 429 430 |
# File 'lib/redis.rb', line 426 def expire(key, seconds) synchronize do |client| client.call([:expire, key, seconds], &Boolify) end end |
#expireat(key, unix_time) ⇒ Boolean
Set the expiration for a key as a UNIX timestamp.
437 438 439 440 441 |
# File 'lib/redis.rb', line 437 def expireat(key, unix_time) synchronize do |client| client.call([:expireat, key, unix_time], &Boolify) end end |
#flushall(options = nil) ⇒ String
Remove all keys from all databases.
276 277 278 279 280 281 282 283 284 |
# File 'lib/redis.rb', line 276 def flushall( = nil) synchronize do |client| if && [:async] client.call(%i[flushall async]) else client.call([:flushall]) end end end |
#flushdb(options = nil) ⇒ String
Remove all keys from the current database.
291 292 293 294 295 296 297 298 299 |
# File 'lib/redis.rb', line 291 def flushdb( = nil) synchronize do |client| if && [:async] client.call(%i[flushdb async]) else client.call([:flushdb]) end end end |
#geoadd(key, *member) ⇒ Integer
Adds the specified geospatial items (latitude, longitude, name) to the specified key
2871 2872 2873 2874 2875 |
# File 'lib/redis.rb', line 2871 def geoadd(key, *member) synchronize do |client| client.call([:geoadd, key, *member]) end end |
#geodist(key, member1, member2, unit = 'm') ⇒ String?
Returns the distance between two members of a geospatial index
2942 2943 2944 2945 2946 |
# File 'lib/redis.rb', line 2942 def geodist(key, member1, member2, unit = 'm') synchronize do |client| client.call([:geodist, key, member1, member2, unit]) end end |
#geohash(key, member) ⇒ Array<String, nil>
Returns geohash string representing position for specified members of the specified key.
2882 2883 2884 2885 2886 |
# File 'lib/redis.rb', line 2882 def geohash(key, member) synchronize do |client| client.call([:geohash, key, member]) end end |
#geopos(key, member) ⇒ Array<Array<String>, nil>
Returns longitude and latitude of members of a geospatial index
2930 2931 2932 2933 2934 |
# File 'lib/redis.rb', line 2930 def geopos(key, member) synchronize do |client| client.call([:geopos, key, member]) end end |
#georadius(*args, **geoptions) ⇒ Array<String>
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point
2898 2899 2900 2901 2902 2903 2904 |
# File 'lib/redis.rb', line 2898 def georadius(*args, **) geoarguments = _geoarguments(*args, **) synchronize do |client| client.call([:georadius, *geoarguments]) end end |
#georadiusbymember(*args, **geoptions) ⇒ Array<String>
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from an already existing member
2916 2917 2918 2919 2920 2921 2922 |
# File 'lib/redis.rb', line 2916 def georadiusbymember(*args, **) geoarguments = _geoarguments(*args, **) synchronize do |client| client.call([:georadiusbymember, *geoarguments]) end end |
#get(key) ⇒ String
Get the value of a key.
954 955 956 957 958 |
# File 'lib/redis.rb', line 954 def get(key) synchronize do |client| client.call([:get, key]) end end |
#getbit(key, offset) ⇒ Integer
Returns the bit value at offset in the string value stored at key.
1038 1039 1040 1041 1042 |
# File 'lib/redis.rb', line 1038 def getbit(key, offset) synchronize do |client| client.call([:getbit, key, offset]) end end |
#getrange(key, start, stop) ⇒ Integer
Get a substring of the string stored at a key.
1015 1016 1017 1018 1019 |
# File 'lib/redis.rb', line 1015 def getrange(key, start, stop) synchronize do |client| client.call([:getrange, key, start, stop]) end end |
#getset(key, value) ⇒ String
Set the string value of a key and return its old value.
1104 1105 1106 1107 1108 |
# File 'lib/redis.rb', line 1104 def getset(key, value) synchronize do |client| client.call([:getset, key, value.to_s]) end end |
#hdel(key, *fields) ⇒ Integer
Delete one or more hash fields.
2247 2248 2249 2250 2251 |
# File 'lib/redis.rb', line 2247 def hdel(key, *fields) synchronize do |client| client.call([:hdel, key, *fields]) end end |
#hexists(key, field) ⇒ Boolean
Determine if a hash field exists.
2258 2259 2260 2261 2262 |
# File 'lib/redis.rb', line 2258 def hexists(key, field) synchronize do |client| client.call([:hexists, key, field], &Boolify) end end |
#hget(key, field) ⇒ String
Get the value of a hash field.
2198 2199 2200 2201 2202 |
# File 'lib/redis.rb', line 2198 def hget(key, field) synchronize do |client| client.call([:hget, key, field]) end end |
#hgetall(key) ⇒ Hash<String, String>
Get all the fields and values in a hash.
2312 2313 2314 2315 2316 |
# File 'lib/redis.rb', line 2312 def hgetall(key) synchronize do |client| client.call([:hgetall, key], &Hashify) end end |
#hincrby(key, field, increment) ⇒ Integer
Increment the integer value of a hash field by the given integer number.
2270 2271 2272 2273 2274 |
# File 'lib/redis.rb', line 2270 def hincrby(key, field, increment) synchronize do |client| client.call([:hincrby, key, field, increment]) end end |
#hincrbyfloat(key, field, increment) ⇒ Float
Increment the numeric value of a hash field by the given float number.
2282 2283 2284 2285 2286 |
# File 'lib/redis.rb', line 2282 def hincrbyfloat(key, field, increment) synchronize do |client| client.call([:hincrbyfloat, key, field, increment], &Floatify) end end |
#hkeys(key) ⇒ Array<String>
Get all the fields in a hash.
2292 2293 2294 2295 2296 |
# File 'lib/redis.rb', line 2292 def hkeys(key) synchronize do |client| client.call([:hkeys, key]) end end |
#hlen(key) ⇒ Integer
Get the number of fields in a hash.
2126 2127 2128 2129 2130 |
# File 'lib/redis.rb', line 2126 def hlen(key) synchronize do |client| client.call([:hlen, key]) end end |
#hmget(key, *fields, &blk) ⇒ Array<String>
Get the values of all the given hash fields.
2215 2216 2217 2218 2219 |
# File 'lib/redis.rb', line 2215 def hmget(key, *fields, &blk) synchronize do |client| client.call([:hmget, key] + fields, &blk) end end |
#hmset(key, *attrs) ⇒ String
Set one or more hash values.
2172 2173 2174 2175 2176 |
# File 'lib/redis.rb', line 2172 def hmset(key, *attrs) synchronize do |client| client.call([:hmset, key] + attrs) end end |
#hscan(key, cursor, **options) ⇒ String, Array<[String, String]>
Scan a hash
2725 2726 2727 2728 2729 |
# File 'lib/redis.rb', line 2725 def hscan(key, cursor, **) _scan(:hscan, cursor, [key], **) do |reply| [reply[0], reply[1].each_slice(2).to_a] end end |
#hscan_each(key, **options, &block) ⇒ Enumerator
Scan a hash
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 |
# File 'lib/redis.rb', line 2742 def hscan_each(key, **, &block) return to_enum(:hscan_each, key, **) unless block_given? cursor = 0 loop do cursor, values = hscan(key, cursor, **) values.each(&block) break if cursor == "0" end end |
#hset(key, *attrs) ⇒ Integer
Set one or more hash values.
2141 2142 2143 2144 2145 2146 2147 |
# File 'lib/redis.rb', line 2141 def hset(key, *attrs) attrs = attrs.first.flatten if attrs.size == 1 && attrs.first.is_a?(Hash) synchronize do |client| client.call([:hset, key, *attrs]) end end |
#hsetnx(key, field, value) ⇒ Boolean
Set the value of a hash field, only if the field does not exist.
2155 2156 2157 2158 2159 |
# File 'lib/redis.rb', line 2155 def hsetnx(key, field, value) synchronize do |client| client.call([:hsetnx, key, field, value], &Boolify) end end |
#hvals(key) ⇒ Array<String>
Get all the values in a hash.
2302 2303 2304 2305 2306 |
# File 'lib/redis.rb', line 2302 def hvals(key) synchronize do |client| client.call([:hvals, key]) end end |
#id ⇒ Object
3340 3341 3342 |
# File 'lib/redis.rb', line 3340 def id @original_client.id end |
#incr(key) ⇒ Integer
Increment the integer value of a key by one.
791 792 793 794 795 |
# File 'lib/redis.rb', line 791 def incr(key) synchronize do |client| client.call([:incr, key]) end end |
#incrby(key, increment) ⇒ Integer
Increment the integer value of a key by the given integer number.
806 807 808 809 810 |
# File 'lib/redis.rb', line 806 def incrby(key, increment) synchronize do |client| client.call([:incrby, key, increment]) end end |
#incrbyfloat(key, increment) ⇒ Float
Increment the numeric value of a key by the given float number.
821 822 823 824 825 |
# File 'lib/redis.rb', line 821 def incrbyfloat(key, increment) synchronize do |client| client.call([:incrbyfloat, key, increment], &Floatify) end end |
#info(cmd = nil) ⇒ Hash<String, String>
Get information and statistics about the server.
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/redis.rb', line 305 def info(cmd = nil) synchronize do |client| client.call([:info, cmd].compact) do |reply| if reply.is_a?(String) reply = HashifyInfo.call(reply) if cmd && cmd.to_s == "commandstats" # Extract nested hashes for INFO COMMANDSTATS reply = Hash[reply.map do |k, v| v = v.split(",").map { |e| e.split("=") } [k[/^cmdstat_(.*)$/, 1], Hash[v]] end] end end reply end end end |
#inspect ⇒ Object
3344 3345 3346 |
# File 'lib/redis.rb', line 3344 def inspect "#<Redis client v#{Redis::VERSION} for #{id}>" end |
#keys(pattern = "*") ⇒ Array<String>
Find all keys matching the given pattern.
617 618 619 620 621 622 623 624 625 626 627 |
# File 'lib/redis.rb', line 617 def keys(pattern = "*") synchronize do |client| client.call([:keys, pattern]) do |reply| if reply.is_a?(String) reply.split(" ") else reply end end end end |
#lastsave ⇒ Integer
Get the UNIX time stamp of the last successful save to disk.
328 329 330 331 332 |
# File 'lib/redis.rb', line 328 def lastsave synchronize do |client| client.call([:lastsave]) end end |
#lindex(key, index) ⇒ String
Get an element from a list by its index.
1301 1302 1303 1304 1305 |
# File 'lib/redis.rb', line 1301 def lindex(key, index) synchronize do |client| client.call([:lindex, key, index]) end end |
#linsert(key, where, pivot, value) ⇒ Integer
Insert an element before or after another element in a list.
1315 1316 1317 1318 1319 |
# File 'lib/redis.rb', line 1315 def linsert(key, where, pivot, value) synchronize do |client| client.call([:linsert, key, where, pivot, value]) end end |
#llen(key) ⇒ Integer
Get the length of a list.
1125 1126 1127 1128 1129 |
# File 'lib/redis.rb', line 1125 def llen(key) synchronize do |client| client.call([:llen, key]) end end |
#lpop(key, count = nil) ⇒ String+
Remove and get the first elements in a list.
1180 1181 1182 1183 1184 1185 1186 |
# File 'lib/redis.rb', line 1180 def lpop(key, count = nil) synchronize do |client| command = [:lpop, key] command << count if count client.call(command) end end |
#lpush(key, value) ⇒ Integer
Prepend one or more values to a list, creating the list if it doesn’t exist
1136 1137 1138 1139 1140 |
# File 'lib/redis.rb', line 1136 def lpush(key, value) synchronize do |client| client.call([:lpush, key, value]) end end |
#lpushx(key, value) ⇒ Integer
Prepend a value to a list, only if the list exists.
1147 1148 1149 1150 1151 |
# File 'lib/redis.rb', line 1147 def lpushx(key, value) synchronize do |client| client.call([:lpushx, key, value]) end end |
#lrange(key, start, stop) ⇒ Array<String>
Get a range of elements from a list.
1327 1328 1329 1330 1331 |
# File 'lib/redis.rb', line 1327 def lrange(key, start, stop) synchronize do |client| client.call([:lrange, key, start, stop]) end end |
#lrem(key, count, value) ⇒ Integer
Remove elements from a list.
1342 1343 1344 1345 1346 |
# File 'lib/redis.rb', line 1342 def lrem(key, count, value) synchronize do |client| client.call([:lrem, key, count, value]) end end |
#lset(key, index, value) ⇒ String
Set the value of an element in a list by its index.
1354 1355 1356 1357 1358 |
# File 'lib/redis.rb', line 1354 def lset(key, index, value) synchronize do |client| client.call([:lset, key, index, value]) end end |
#ltrim(key, start, stop) ⇒ String
Trim a list to the specified range.
1366 1367 1368 1369 1370 |
# File 'lib/redis.rb', line 1366 def ltrim(key, start, stop) synchronize do |client| client.call([:ltrim, key, start, stop]) end end |
#mapped_hmget(key, *fields) ⇒ Hash
Get the values of all the given hash fields.
2232 2233 2234 2235 2236 2237 2238 2239 2240 |
# File 'lib/redis.rb', line 2232 def mapped_hmget(key, *fields) hmget(key, *fields) do |reply| if reply.is_a?(Array) Hash[fields.zip(reply)] else reply end end end |
#mapped_hmset(key, hash) ⇒ String
Set one or more hash values.
2189 2190 2191 |
# File 'lib/redis.rb', line 2189 def mapped_hmset(key, hash) hmset(key, hash.to_a.flatten) end |
#mapped_mget(*keys) ⇒ Hash
Get the values of all the given keys.
986 987 988 989 990 991 992 993 994 |
# File 'lib/redis.rb', line 986 def mapped_mget(*keys) mget(*keys) do |reply| if reply.is_a?(Array) Hash[keys.zip(reply)] else reply end end end |
#mapped_mset(hash) ⇒ String
Set one or more values.
916 917 918 |
# File 'lib/redis.rb', line 916 def mapped_mset(hash) mset(hash.to_a.flatten) end |
#mapped_msetnx(hash) ⇒ Boolean
Set one or more values, only if none of the keys exist.
946 947 948 |
# File 'lib/redis.rb', line 946 def mapped_msetnx(hash) msetnx(hash.to_a.flatten) end |
#mget(*keys, &blk) ⇒ Array<String>
Get the values of all the given keys.
970 971 972 973 974 |
# File 'lib/redis.rb', line 970 def mget(*keys, &blk) synchronize do |client| client.call([:mget, *keys], &blk) end end |
#migrate(key, options) ⇒ String
Transfer a key from the connected instance to another instance.
539 540 541 542 543 544 545 546 547 548 549 550 551 |
# File 'lib/redis.rb', line 539 def migrate(key, ) args = [:migrate] args << ([:host] || raise(':host not specified')) args << ([:port] || raise(':port not specified')) args << (key.is_a?(String) ? key : '') args << ([:db] || @client.db).to_i args << ([:timeout] || @client.timeout).to_i args << 'COPY' if [:copy] args << 'REPLACE' if [:replace] args += ['KEYS', *key] if key.is_a?(Array) synchronize { |client| client.call(args) } end |
#monitor {|line| ... } ⇒ Object
Listen for all requests received by the server in real time.
There is no way to interrupt this command.
340 341 342 343 344 |
# File 'lib/redis.rb', line 340 def monitor(&block) synchronize do |client| client.call_loop([:monitor], &block) end end |
#move(key, db) ⇒ Boolean
Move a key to another database.
648 649 650 651 652 |
# File 'lib/redis.rb', line 648 def move(key, db) synchronize do |client| client.call([:move, key, db], &Boolify) end end |
#mset(*args) ⇒ String
Set one or more values.
900 901 902 903 904 |
# File 'lib/redis.rb', line 900 def mset(*args) synchronize do |client| client.call([:mset] + args) end end |
#msetnx(*args) ⇒ Boolean
Set one or more values, only if none of the keys exist.
930 931 932 933 934 |
# File 'lib/redis.rb', line 930 def msetnx(*args) synchronize do |client| client.call([:msetnx, *args], &Boolify) end end |
#multi {|multi| ... } ⇒ String, Array<...>
Mark the start of a transaction block.
Passing a block is optional.
2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 |
# File 'lib/redis.rb', line 2490 def multi synchronize do |prior_client| if !block_given? prior_client.call([:multi]) else begin @client = Pipeline::Multi.new(prior_client) yield(self) prior_client.call_pipeline(@client) ensure @client = prior_client end end end end |
#object(*args) ⇒ Object
654 655 656 657 658 |
# File 'lib/redis.rb', line 654 def object(*args) synchronize do |client| client.call([:object] + args) end end |
#persist(key) ⇒ Boolean
Remove the expiration from a key.
415 416 417 418 419 |
# File 'lib/redis.rb', line 415 def persist(key) synchronize do |client| client.call([:persist, key], &Boolify) end end |
#pexpire(key, milliseconds) ⇒ Boolean
Set a key’s time to live in milliseconds.
466 467 468 469 470 |
# File 'lib/redis.rb', line 466 def pexpire(key, milliseconds) synchronize do |client| client.call([:pexpire, key, milliseconds], &Boolify) end end |
#pexpireat(key, ms_unix_time) ⇒ Boolean
Set the expiration for a key as number of milliseconds from UNIX Epoch.
477 478 479 480 481 |
# File 'lib/redis.rb', line 477 def pexpireat(key, ms_unix_time) synchronize do |client| client.call([:pexpireat, key, ms_unix_time], &Boolify) end end |
#pfadd(key, member) ⇒ Boolean
Add one or more members to a HyperLogLog structure.
2835 2836 2837 2838 2839 |
# File 'lib/redis.rb', line 2835 def pfadd(key, member) synchronize do |client| client.call([:pfadd, key, member], &Boolify) end end |
#pfcount(*keys) ⇒ Integer
Get the approximate cardinality of members added to HyperLogLog structure.
If called with multiple keys, returns the approximate cardinality of the union of the HyperLogLogs contained in the keys.
2848 2849 2850 2851 2852 |
# File 'lib/redis.rb', line 2848 def pfcount(*keys) synchronize do |client| client.call([:pfcount] + keys) end end |
#pfmerge(dest_key, *source_key) ⇒ Boolean
Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
2860 2861 2862 2863 2864 |
# File 'lib/redis.rb', line 2860 def pfmerge(dest_key, *source_key) synchronize do |client| client.call([:pfmerge, dest_key, *source_key], &BoolifySet) end end |
#ping(message = nil) ⇒ String
Ping the server.
172 173 174 175 176 |
# File 'lib/redis.rb', line 172 def ping( = nil) synchronize do |client| client.call([:ping, ].compact) end end |
#pipelined ⇒ Object
2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 |
# File 'lib/redis.rb', line 2448 def pipelined synchronize do |prior_client| begin @client = Pipeline.new(prior_client) yield(self) prior_client.call_pipeline(@client) ensure @client = prior_client end end end |
#psetex(key, ttl, value) ⇒ String
Set the time to live in milliseconds of a key.
873 874 875 876 877 |
# File 'lib/redis.rb', line 873 def psetex(key, ttl, value) synchronize do |client| client.call([:psetex, key, ttl, value.to_s]) end end |
#psubscribe(*channels, &block) ⇒ Object
Listen for messages published to channels matching the given patterns.
2356 2357 2358 2359 2360 |
# File 'lib/redis.rb', line 2356 def psubscribe(*channels, &block) synchronize do |_client| _subscription(:psubscribe, 0, channels, block) end end |
#psubscribe_with_timeout(timeout, *channels, &block) ⇒ Object
Listen for messages published to channels matching the given patterns. Throw a timeout error if there is no messages for a timeout period.
2364 2365 2366 2367 2368 |
# File 'lib/redis.rb', line 2364 def psubscribe_with_timeout(timeout, *channels, &block) synchronize do |_client| _subscription(:psubscribe_with_timeout, timeout, channels, block) end end |
#pttl(key) ⇒ Integer
Get the time to live (in milliseconds) for a key.
In Redis 2.6 or older the command returns -1 if the key does not exist or if the key exist but has no associated expire.
Starting with Redis 2.8 the return value in case of error changed:
- The command returns -2 if the key does not exist.
- The command returns -1 if the key exists but has no associated expire.
494 495 496 497 498 |
# File 'lib/redis.rb', line 494 def pttl(key) synchronize do |client| client.call([:pttl, key]) end end |
#publish(channel, message) ⇒ Object
Post a message to a channel.
2319 2320 2321 2322 2323 |
# File 'lib/redis.rb', line 2319 def publish(channel, ) synchronize do |client| client.call([:publish, channel, ]) end end |
#pubsub(subcommand, *args) ⇒ Object
Inspect the state of the Pub/Sub subsystem. Possible subcommands: channels, numsub, numpat.
2381 2382 2383 2384 2385 |
# File 'lib/redis.rb', line 2381 def pubsub(subcommand, *args) synchronize do |client| client.call([:pubsub, subcommand] + args) end end |
#punsubscribe(*channels) ⇒ Object
Stop listening for messages posted to channels matching the given patterns.
2371 2372 2373 2374 2375 2376 2377 |
# File 'lib/redis.rb', line 2371 def punsubscribe(*channels) synchronize do |client| raise "Can't unsubscribe if not subscribed." unless subscribed? client.punsubscribe(*channels) end end |
#queue(*command) ⇒ Object
Queues a command for pipelining.
Commands in the queue are executed with the Redis#commit method.
See redis.io/topics/pipelining for more details.
116 117 118 119 120 |
# File 'lib/redis.rb', line 116 def queue(*command) synchronize do @queue[Thread.current.object_id] << command end end |
#quit ⇒ String
Close the connection.
191 192 193 194 195 196 197 198 199 200 |
# File 'lib/redis.rb', line 191 def quit synchronize do |client| begin client.call([:quit]) rescue ConnectionError ensure client.disconnect end end end |
#randomkey ⇒ String
Return a random key from the keyspace.
663 664 665 666 667 |
# File 'lib/redis.rb', line 663 def randomkey synchronize do |client| client.call([:randomkey]) end end |
#rename(old_name, new_name) ⇒ String
Rename a key. If the new key already exists it is overwritten.
674 675 676 677 678 |
# File 'lib/redis.rb', line 674 def rename(old_name, new_name) synchronize do |client| client.call([:rename, old_name, new_name]) end end |
#renamenx(old_name, new_name) ⇒ Boolean
Rename a key, only if the new key does not exist.
685 686 687 688 689 |
# File 'lib/redis.rb', line 685 def renamenx(old_name, new_name) synchronize do |client| client.call([:renamenx, old_name, new_name], &Boolify) end end |
#restore(key, ttl, serialized_value, replace: nil) ⇒ String
Create a key using the serialized value, previously obtained using DUMP.
519 520 521 522 523 524 525 526 |
# File 'lib/redis.rb', line 519 def restore(key, ttl, serialized_value, replace: nil) args = [:restore, key, ttl, serialized_value] args << 'REPLACE' if replace synchronize do |client| client.call(args) end end |
#rpop(key, count = nil) ⇒ String+
Remove and get the last elements in a list.
1193 1194 1195 1196 1197 1198 1199 |
# File 'lib/redis.rb', line 1193 def rpop(key, count = nil) synchronize do |client| command = [:rpop, key] command << count if count client.call(command) end end |
#rpoplpush(source, destination) ⇒ nil, String
Remove the last element in a list, append it to another list and return it.
1206 1207 1208 1209 1210 |
# File 'lib/redis.rb', line 1206 def rpoplpush(source, destination) synchronize do |client| client.call([:rpoplpush, source, destination]) end end |
#rpush(key, value) ⇒ Integer
Append one or more values to a list, creating the list if it doesn’t exist
1158 1159 1160 1161 1162 |
# File 'lib/redis.rb', line 1158 def rpush(key, value) synchronize do |client| client.call([:rpush, key, value]) end end |
#rpushx(key, value) ⇒ Integer
Append a value to a list, only if the list exists.
1169 1170 1171 1172 1173 |
# File 'lib/redis.rb', line 1169 def rpushx(key, value) synchronize do |client| client.call([:rpushx, key, value]) end end |
#sadd(key, member) ⇒ Boolean, Integer
Add one or more members to a set.
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 |
# File 'lib/redis.rb', line 1390 def sadd(key, member) synchronize do |client| client.call([:sadd, key, member]) do |reply| if member.is_a? Array # Variadic: return integer reply else # Single argument: return boolean Boolify.call(reply) end end end end |
#save ⇒ String
Synchronously save the dataset to disk.
349 350 351 352 353 |
# File 'lib/redis.rb', line 349 def save synchronize do |client| client.call([:save]) end end |
#scan(cursor, **options) ⇒ String+
Scan the keyspace
2679 2680 2681 |
# File 'lib/redis.rb', line 2679 def scan(cursor, **) _scan(:scan, cursor, [], **) end |
#scan_each(**options, &block) ⇒ Enumerator
Scan the keyspace
2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 |
# File 'lib/redis.rb', line 2703 def scan_each(**, &block) return to_enum(:scan_each, **) unless block_given? cursor = 0 loop do cursor, keys = scan(cursor, **) keys.each(&block) break if cursor == "0" end end |
#scard(key) ⇒ Integer
Get the number of members in a set.
1376 1377 1378 1379 1380 |
# File 'lib/redis.rb', line 1376 def scard(key) synchronize do |client| client.call([:scard, key]) end end |
#script(subcommand, *args) ⇒ String, ...
Control remote script registry.
2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 |
# File 'lib/redis.rb', line 2560 def script(subcommand, *args) subcommand = subcommand.to_s.downcase if subcommand == "exists" synchronize do |client| arg = args.first client.call([:script, :exists, arg]) do |reply| reply = reply.map { |r| Boolify.call(r) } if arg.is_a?(Array) reply else reply.first end end end else synchronize do |client| client.call([:script, subcommand] + args) end end end |
#sdiff(*keys) ⇒ Array<String>
Subtract multiple sets.
1493 1494 1495 1496 1497 |
# File 'lib/redis.rb', line 1493 def sdiff(*keys) synchronize do |client| client.call([:sdiff, *keys]) end end |
#sdiffstore(destination, *keys) ⇒ Integer
Subtract multiple sets and store the resulting set in a key.
1504 1505 1506 1507 1508 |
# File 'lib/redis.rb', line 1504 def sdiffstore(destination, *keys) synchronize do |client| client.call([:sdiffstore, destination, *keys]) end end |
#select(db) ⇒ String
Change the selected database for the current connection.
161 162 163 164 165 166 |
# File 'lib/redis.rb', line 161 def select(db) synchronize do |client| client.db = db client.call([:select, db]) end end |
#sentinel(subcommand, *args) ⇒ Array<String>, ...
Interact with the sentinel command (masters, master, slaves, failover)
3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 |
# File 'lib/redis.rb', line 3278 def sentinel(subcommand, *args) subcommand = subcommand.to_s.downcase synchronize do |client| client.call([:sentinel, subcommand] + args) do |reply| case subcommand when "get-master-addr-by-name" reply else if reply.is_a?(Array) if reply[0].is_a?(Array) reply.map(&Hashify) else Hashify.call(reply) end else reply end end end end end |
#set(key, value, ex: nil, px: nil, nx: nil, xx: nil, keepttl: nil) ⇒ String, Boolean
Set the string value of a key.
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 |
# File 'lib/redis.rb', line 838 def set(key, value, ex: nil, px: nil, nx: nil, xx: nil, keepttl: nil) args = [:set, key, value.to_s] args << "EX" << ex if ex args << "PX" << px if px args << "NX" if nx args << "XX" if xx args << "KEEPTTL" if keepttl synchronize do |client| if nx || xx client.call(args, &BoolifySet) else client.call(args) end end end |
#setbit(key, offset, value) ⇒ Integer
Sets or clears the bit at offset in the string value stored at key.
1027 1028 1029 1030 1031 |
# File 'lib/redis.rb', line 1027 def setbit(key, offset, value) synchronize do |client| client.call([:setbit, key, offset, value]) end end |
#setex(key, ttl, value) ⇒ String
Set the time to live in seconds of a key.
861 862 863 864 865 |
# File 'lib/redis.rb', line 861 def setex(key, ttl, value) synchronize do |client| client.call([:setex, key, ttl, value.to_s]) end end |
#setnx(key, value) ⇒ Boolean
Set the value of a key, only if the key does not exist.
884 885 886 887 888 |
# File 'lib/redis.rb', line 884 def setnx(key, value) synchronize do |client| client.call([:setnx, key, value.to_s], &Boolify) end end |
#setrange(key, offset, value) ⇒ Integer
Overwrite part of a string at key starting at the specified offset.
1002 1003 1004 1005 1006 |
# File 'lib/redis.rb', line 1002 def setrange(key, offset, value) synchronize do |client| client.call([:setrange, key, offset, value.to_s]) end end |
#shutdown ⇒ Object
Synchronously save the dataset to disk and then shut down the server.
356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/redis.rb', line 356 def shutdown synchronize do |client| client.with_reconnect(false) do begin client.call([:shutdown]) rescue ConnectionError # This means Redis has probably exited. nil end end end end |
#sinter(*keys) ⇒ Array<String>
Intersect multiple sets.
1514 1515 1516 1517 1518 |
# File 'lib/redis.rb', line 1514 def sinter(*keys) synchronize do |client| client.call([:sinter, *keys]) end end |
#sinterstore(destination, *keys) ⇒ Integer
Intersect multiple sets and store the resulting set in a key.
1525 1526 1527 1528 1529 |
# File 'lib/redis.rb', line 1525 def sinterstore(destination, *keys) synchronize do |client| client.call([:sinterstore, destination, *keys]) end end |
#sismember(key, member) ⇒ Boolean
Determine if a given value is a member of a set.
1473 1474 1475 1476 1477 |
# File 'lib/redis.rb', line 1473 def sismember(key, member) synchronize do |client| client.call([:sismember, key, member], &Boolify) end end |
#slaveof(host, port) ⇒ Object
Make the server a slave of another instance, or promote it as master.
370 371 372 373 374 |
# File 'lib/redis.rb', line 370 def slaveof(host, port) synchronize do |client| client.call([:slaveof, host, port]) end end |
#slowlog(subcommand, length = nil) ⇒ Array<String>, ...
Interact with the slowlog (get, len, reset)
381 382 383 384 385 386 387 |
# File 'lib/redis.rb', line 381 def slowlog(subcommand, length = nil) synchronize do |client| args = [:slowlog, subcommand] args << length if length client.call args end end |
#smembers(key) ⇒ Array<String>
Get all the members in a set.
1483 1484 1485 1486 1487 |
# File 'lib/redis.rb', line 1483 def smembers(key) synchronize do |client| client.call([:smembers, key]) end end |
#smove(source, destination, member) ⇒ Boolean
Move a member from one set to another.
1462 1463 1464 1465 1466 |
# File 'lib/redis.rb', line 1462 def smove(source, destination, member) synchronize do |client| client.call([:smove, source, destination, member], &Boolify) end end |
#sort(key, by: nil, limit: nil, get: nil, order: nil, store: nil) ⇒ Array<String>, ...
Sort the elements in a list, set or sorted set.
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 |
# File 'lib/redis.rb', line 716 def sort(key, by: nil, limit: nil, get: nil, order: nil, store: nil) args = [:sort, key] args << "BY" << by if by if limit args << "LIMIT" args.concat(limit) end get = Array(get) get.each do |item| args << "GET" << item end args.concat(order.split(" ")) if order args << "STORE" << store if store synchronize do |client| client.call(args) do |reply| if get.size > 1 && !store reply.each_slice(get.size).to_a if reply else reply end end end end |
#spop(key, count = nil) ⇒ String
Remove and return one or more random member from a set.
1431 1432 1433 1434 1435 1436 1437 1438 1439 |
# File 'lib/redis.rb', line 1431 def spop(key, count = nil) synchronize do |client| if count.nil? client.call([:spop, key]) else client.call([:spop, key, count]) end end end |
#srandmember(key, count = nil) ⇒ String
Get one or more random members from a set.
1446 1447 1448 1449 1450 1451 1452 1453 1454 |
# File 'lib/redis.rb', line 1446 def srandmember(key, count = nil) synchronize do |client| if count.nil? client.call([:srandmember, key]) else client.call([:srandmember, key, count]) end end end |
#srem(key, member) ⇒ Boolean, Integer
Remove one or more members from a set.
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 |
# File 'lib/redis.rb', line 1412 def srem(key, member) synchronize do |client| client.call([:srem, key, member]) do |reply| if member.is_a? Array # Variadic: return integer reply else # Single argument: return boolean Boolify.call(reply) end end end end |
#sscan(key, cursor, **options) ⇒ String+
Scan a set
2804 2805 2806 |
# File 'lib/redis.rb', line 2804 def sscan(key, cursor, **) _scan(:sscan, cursor, [key], **) end |
#sscan_each(key, **options, &block) ⇒ Enumerator
Scan a set
2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 |
# File 'lib/redis.rb', line 2819 def sscan_each(key, **, &block) return to_enum(:sscan_each, key, **) unless block_given? cursor = 0 loop do cursor, keys = sscan(key, cursor, **) keys.each(&block) break if cursor == "0" end end |
#strlen(key) ⇒ Integer
Get the length of the value stored in a key.
1115 1116 1117 1118 1119 |
# File 'lib/redis.rb', line 1115 def strlen(key) synchronize do |client| client.call([:strlen, key]) end end |
#subscribe(*channels, &block) ⇒ Object
Listen for messages published to the given channels.
2332 2333 2334 2335 2336 |
# File 'lib/redis.rb', line 2332 def subscribe(*channels, &block) synchronize do |_client| _subscription(:subscribe, 0, channels, block) end end |
#subscribe_with_timeout(timeout, *channels, &block) ⇒ Object
Listen for messages published to the given channels. Throw a timeout error if there is no messages for a timeout period.
2340 2341 2342 2343 2344 |
# File 'lib/redis.rb', line 2340 def subscribe_with_timeout(timeout, *channels, &block) synchronize do |_client| _subscription(:subscribe_with_timeout, timeout, channels, block) end end |
#subscribed? ⇒ Boolean
2325 2326 2327 2328 2329 |
# File 'lib/redis.rb', line 2325 def subscribed? synchronize do |client| client.is_a? SubscribedClient end end |
#sunion(*keys) ⇒ Array<String>
Add multiple sets.
1535 1536 1537 1538 1539 |
# File 'lib/redis.rb', line 1535 def sunion(*keys) synchronize do |client| client.call([:sunion, *keys]) end end |
#sunionstore(destination, *keys) ⇒ Integer
Add multiple sets and store the resulting set in a key.
1546 1547 1548 1549 1550 |
# File 'lib/redis.rb', line 1546 def sunionstore(destination, *keys) synchronize do |client| client.call([:sunionstore, destination, *keys]) end end |
#sync ⇒ Object
Internal command used for replication.
390 391 392 393 394 |
# File 'lib/redis.rb', line 390 def sync synchronize do |client| client.call([:sync]) end end |
#synchronize ⇒ Object
69 70 71 |
# File 'lib/redis.rb', line 69 def synchronize mon_synchronize { yield(@client) } end |
#time ⇒ Array<Integer>
Return the server time.
403 404 405 406 407 408 409 |
# File 'lib/redis.rb', line 403 def time synchronize do |client| client.call([:time]) do |reply| reply&.map(&:to_i) end end end |
#ttl(key) ⇒ Integer
Get the time to live (in seconds) for a key.
In Redis 2.6 or older the command returns -1 if the key does not exist or if the key exist but has no associated expire.
Starting with Redis 2.8 the return value in case of error changed:
- The command returns -2 if the key does not exist.
- The command returns -1 if the key exists but has no associated expire.
455 456 457 458 459 |
# File 'lib/redis.rb', line 455 def ttl(key) synchronize do |client| client.call([:ttl, key]) end end |
#type(key) ⇒ String
Determine the type stored at key.
748 749 750 751 752 |
# File 'lib/redis.rb', line 748 def type(key) synchronize do |client| client.call([:type, key]) end end |
#unlink(*keys) ⇒ Integer
Unlink one or more keys.
567 568 569 570 571 |
# File 'lib/redis.rb', line 567 def unlink(*keys) synchronize do |client| client.call([:unlink] + keys) end end |
#unsubscribe(*channels) ⇒ Object
Stop listening for messages posted to the given channels.
2347 2348 2349 2350 2351 2352 2353 |
# File 'lib/redis.rb', line 2347 def unsubscribe(*channels) synchronize do |client| raise "Can't unsubscribe if not subscribed." unless subscribed? client.unsubscribe(*channels) end end |
#unwatch ⇒ String
Forget about all watched keys.
2442 2443 2444 2445 2446 |
# File 'lib/redis.rb', line 2442 def unwatch synchronize do |client| client.call([:unwatch]) end end |
#watch(*keys) ⇒ Object, String
Watch the given keys to determine execution of the MULTI/EXEC block.
Using a block is optional, but is necessary for thread-safety.
An ‘#unwatch` is automatically issued if an exception is raised within the block that is a subclass of StandardError and is not a ConnectionError.
2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 |
# File 'lib/redis.rb', line 2417 def watch(*keys) synchronize do |client| res = client.call([:watch, *keys]) if block_given? begin yield(self) rescue ConnectionError raise rescue StandardError unwatch raise end else res end end end |
#with_reconnect(val = true, &blk) ⇒ Object
Run code with the client reconnecting
74 75 76 77 78 |
# File 'lib/redis.rb', line 74 def with_reconnect(val = true, &blk) synchronize do |client| client.with_reconnect(val, &blk) end end |
#without_reconnect(&blk) ⇒ Object
Run code without the client reconnecting
81 82 83 |
# File 'lib/redis.rb', line 81 def without_reconnect(&blk) with_reconnect(false, &blk) end |
#xack(key, group, *ids) ⇒ Integer
Removes one or multiple entries from the pending entries list of a stream consumer group.
3193 3194 3195 3196 |
# File 'lib/redis.rb', line 3193 def xack(key, group, *ids) args = [:xack, key, group].concat(ids.flatten) synchronize { |client| client.call(args) } end |
#xadd(key, entry, approximate: nil, maxlen: nil, id: '*') ⇒ String
Add new entry to the stream.
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 |
# File 'lib/redis.rb', line 2993 def xadd(key, entry, approximate: nil, maxlen: nil, id: '*') args = [:xadd, key] if maxlen args << "MAXLEN" args << "~" if approximate args << maxlen end args << id args.concat(entry.to_a.flatten) synchronize { |client| client.call(args) } end |
#xclaim(key, group, consumer, min_idle_time, *ids, **opts) ⇒ Hash{String => Hash}, Array<String>
Changes the ownership of a pending entry
3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 |
# File 'lib/redis.rb', line 3230 def xclaim(key, group, consumer, min_idle_time, *ids, **opts) args = [:xclaim, key, group, consumer, min_idle_time].concat(ids.flatten) args.concat(['IDLE', opts[:idle].to_i]) if opts[:idle] args.concat(['TIME', opts[:time].to_i]) if opts[:time] args.concat(['RETRYCOUNT', opts[:retrycount]]) if opts[:retrycount] args << 'FORCE' if opts[:force] args << 'JUSTID' if opts[:justid] blk = opts[:justid] ? Noop : HashifyStreamEntries synchronize { |client| client.call(args, &blk) } end |
#xdel(key, *ids) ⇒ Integer
Delete entries by entry ids.
3033 3034 3035 3036 |
# File 'lib/redis.rb', line 3033 def xdel(key, *ids) args = [:xdel, key].concat(ids.flatten) synchronize { |client| client.call(args) } end |
#xgroup(subcommand, key, group, id_or_consumer = nil, mkstream: false) ⇒ String, Integer
Manages the consumer group of the stream.
3141 3142 3143 3144 |
# File 'lib/redis.rb', line 3141 def xgroup(subcommand, key, group, id_or_consumer = nil, mkstream: false) args = [:xgroup, subcommand, key, group, id_or_consumer, (mkstream ? 'MKSTREAM' : nil)].compact synchronize { |client| client.call(args) } end |
#xinfo(subcommand, key, group = nil) ⇒ Hash+
Returns the stream information each subcommand.
2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 |
# File 'lib/redis.rb', line 2964 def xinfo(subcommand, key, group = nil) args = [:xinfo, subcommand, key, group].compact synchronize do |client| client.call(args) do |reply| case subcommand.to_s.downcase when 'stream' then Hashify.call(reply) when 'groups', 'consumers' then reply.map { |arr| Hashify.call(arr) } else reply end end end end |
#xlen(key) ⇒ Integer
Returns the number of entries inside a stream.
3092 3093 3094 |
# File 'lib/redis.rb', line 3092 def xlen(key) synchronize { |client| client.call([:xlen, key]) } end |
#xpending(key, group, *args) ⇒ Hash+
Fetches not acknowledging pending entries
3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 |
# File 'lib/redis.rb', line 3259 def xpending(key, group, *args) command_args = [:xpending, key, group] case args.size when 0, 3, 4 command_args.concat(args) else raise ArgumentError, "wrong number of arguments (given #{args.size + 2}, expected 2, 5 or 6)" end summary_needed = args.empty? blk = summary_needed ? HashifyStreamPendings : HashifyStreamPendingDetails synchronize { |client| client.call(command_args, &blk) } end |
#xrange(key, start = '-', range_end = '+', count: nil) ⇒ Array<Array<String, Hash>>
Fetches entries of the stream in ascending order.
3055 3056 3057 3058 3059 |
# File 'lib/redis.rb', line 3055 def xrange(key, start = '-', range_end = '+', count: nil) args = [:xrange, key, start, range_end] args.concat(['COUNT', count]) if count synchronize { |client| client.call(args, &HashifyStreamEntries) } end |
#xread(keys, ids, count: nil, block: nil) ⇒ Hash{String => Hash{String => Hash}}
Fetches entries from one or multiple streams. Optionally blocking.
3113 3114 3115 3116 3117 3118 |
# File 'lib/redis.rb', line 3113 def xread(keys, ids, count: nil, block: nil) args = [:xread] args << 'COUNT' << count if count args << 'BLOCK' << block.to_i if block _xread(args, keys, ids, block) end |
#xreadgroup(group, consumer, keys, ids, count: nil, block: nil, noack: nil) ⇒ Hash{String => Hash{String => Hash}}
Fetches a subset of the entries from one or multiple streams related with the consumer group. Optionally blocking.
3171 3172 3173 3174 3175 3176 3177 |
# File 'lib/redis.rb', line 3171 def xreadgroup(group, consumer, keys, ids, count: nil, block: nil, noack: nil) args = [:xreadgroup, 'GROUP', group, consumer] args << 'COUNT' << count if count args << 'BLOCK' << block.to_i if block args << 'NOACK' if noack _xread(args, keys, ids, block) end |
#xrevrange(key, range_end = '+', start = '-', count: nil) ⇒ Array<Array<String, Hash>>
Fetches entries of the stream in descending order.
3078 3079 3080 3081 3082 |
# File 'lib/redis.rb', line 3078 def xrevrange(key, range_end = '+', start = '-', count: nil) args = [:xrevrange, key, range_end, start] args.concat(['COUNT', count]) if count synchronize { |client| client.call(args, &HashifyStreamEntries) } end |
#xtrim(key, maxlen, approximate: false) ⇒ Integer
Trims older entries of the stream if needed.
3017 3018 3019 3020 |
# File 'lib/redis.rb', line 3017 def xtrim(key, maxlen, approximate: false) args = [:xtrim, key, 'MAXLEN', (approximate ? '~' : nil), maxlen].compact synchronize { |client| client.call(args) } end |
#zadd(key, *args, nx: nil, xx: nil, ch: nil, incr: nil) ⇒ Boolean, ...
Add one or more members to a sorted set, or update the score for members that already exist.
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 |
# File 'lib/redis.rb', line 1597 def zadd(key, *args, nx: nil, xx: nil, ch: nil, incr: nil) command = [:zadd, key] command << "NX" if nx command << "XX" if xx command << "CH" if ch command << "INCR" if incr synchronize do |client| if args.size == 1 && args[0].is_a?(Array) # Variadic: return float if INCR, integer if !INCR client.call(command + args[0], &(incr ? Floatify : nil)) elsif args.size == 2 # Single pair: return float if INCR, boolean if !INCR client.call(command + args, &(incr ? Floatify : Boolify)) else raise ArgumentError, "wrong number of arguments" end end end |
#zcard(key) ⇒ Integer
Get the number of members in a sorted set.
1560 1561 1562 1563 1564 |
# File 'lib/redis.rb', line 1560 def zcard(key) synchronize do |client| client.call([:zcard, key]) end end |
#zcount(key, min, max) ⇒ Integer
Count the members in a sorted set with scores within the given values.
2059 2060 2061 2062 2063 |
# File 'lib/redis.rb', line 2059 def zcount(key, min, max) synchronize do |client| client.call([:zcount, key, min, max]) end end |
#zincrby(key, increment, member) ⇒ Float
Increment the score of a member in a sorted set.
1627 1628 1629 1630 1631 |
# File 'lib/redis.rb', line 1627 def zincrby(key, increment, member) synchronize do |client| client.call([:zincrby, key, increment, member], &Floatify) end end |
#zinterstore(destination, keys, weights: nil, aggregate: nil) ⇒ Integer
Intersect multiple sorted sets and store the resulting sorted set in a new key.
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 |
# File 'lib/redis.rb', line 2079 def zinterstore(destination, keys, weights: nil, aggregate: nil) args = [:zinterstore, destination, keys.size, *keys] if weights args << "WEIGHTS" args.concat(weights) end args << "AGGREGATE" << aggregate if aggregate synchronize do |client| client.call(args) end end |
#zlexcount(key, min, max) ⇒ Integer
Count the members, with the same score in a sorted set, within the given lexicographical range.
1878 1879 1880 1881 1882 |
# File 'lib/redis.rb', line 1878 def zlexcount(key, min, max) synchronize do |client| client.call([:zlexcount, key, min, max]) 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.
1678 1679 1680 1681 1682 1683 |
# File 'lib/redis.rb', line 1678 def zpopmax(key, count = nil) synchronize do |client| members = client.call([:zpopmax, key, count].compact, &FloatifyPairs) 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.
1699 1700 1701 1702 1703 1704 |
# File 'lib/redis.rb', line 1699 def zpopmin(key, count = nil) synchronize do |client| members = client.call([:zpopmin, key, count].compact, &FloatifyPairs) count.to_i > 1 ? members : members.first end end |
#zrange(key, start, stop, withscores: false, with_scores: withscores) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by index.
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 |
# File 'lib/redis.rb', line 1781 def zrange(key, start, stop, withscores: false, with_scores: withscores) args = [:zrange, key, start, stop] if with_scores args << "WITHSCORES" block = FloatifyPairs end synchronize do |client| client.call(args, &block) end 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
1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 |
# File 'lib/redis.rb', line 1905 def zrangebylex(key, min, max, limit: nil) args = [:zrangebylex, key, min, max] if limit args << "LIMIT" args.concat(limit) end synchronize do |client| client.call(args) end 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.
1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 |
# File 'lib/redis.rb', line 1969 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 synchronize do |client| client.call(args, &block) end end |
#zrank(key, member) ⇒ Integer
Determine the index of a member in a sorted set.
1823 1824 1825 1826 1827 |
# File 'lib/redis.rb', line 1823 def zrank(key, member) synchronize do |client| client.call([:zrank, key, member]) end end |
#zrem(key, member) ⇒ Boolean, Integer
Remove one or more members from a sorted set.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 |
# File 'lib/redis.rb', line 1650 def zrem(key, member) synchronize do |client| client.call([: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 end |
#zremrangebyrank(key, start, stop) ⇒ Integer
Remove all members in a sorted set within the given indexes.
1854 1855 1856 1857 1858 |
# File 'lib/redis.rb', line 1854 def zremrangebyrank(key, start, stop) synchronize do |client| client.call([:zremrangebyrank, key, start, stop]) end end |
#zremrangebyscore(key, min, max) ⇒ Integer
Remove all members in a sorted set within the given scores.
2036 2037 2038 2039 2040 |
# File 'lib/redis.rb', line 2036 def zremrangebyscore(key, min, max) synchronize do |client| client.call([:zremrangebyscore, key, min, max]) end 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.
1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 |
# File 'lib/redis.rb', line 1805 def zrevrange(key, start, stop, withscores: false, with_scores: withscores) args = [:zrevrange, key, start, stop] if with_scores args << "WITHSCORES" block = FloatifyPairs end synchronize do |client| client.call(args, &block) end 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.
1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 |
# File 'lib/redis.rb', line 1929 def zrevrangebylex(key, max, min, limit: nil) args = [:zrevrangebylex, key, max, min] if limit args << "LIMIT" args.concat(limit) end synchronize do |client| client.call(args) end 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.
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/redis.rb', line 2001 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 synchronize do |client| client.call(args, &block) end end |
#zrevrank(key, member) ⇒ Integer
Determine the index of a member in a sorted set, with scores ordered from high to low.
1835 1836 1837 1838 1839 |
# File 'lib/redis.rb', line 1835 def zrevrank(key, member) synchronize do |client| client.call([:zrevrank, key, member]) end end |
#zscan(key, cursor, **options) ⇒ String, Array<[String, Float]>
Scan a sorted set
2765 2766 2767 2768 2769 |
# File 'lib/redis.rb', line 2765 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
2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 |
# File 'lib/redis.rb', line 2782 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.
1757 1758 1759 1760 1761 |
# File 'lib/redis.rb', line 1757 def zscore(key, member) synchronize do |client| client.call([:zscore, key, member], &Floatify) end end |
#zunionstore(destination, keys, weights: nil, aggregate: nil) ⇒ Integer
Add multiple sorted sets and store the resulting sorted set in a new key.
2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 |
# File 'lib/redis.rb', line 2107 def zunionstore(destination, keys, weights: nil, aggregate: nil) args = [:zunionstore, destination, keys.size, *keys] if weights args << "WEIGHTS" args.concat(weights) end args << "AGGREGATE" << aggregate if aggregate synchronize do |client| client.call(args) end end |