Class: Redis
- Inherits:
-
Object
- Object
- Redis
- Includes:
- MonitorMixin
- Defined in:
- lib/redis.rb,
lib/redis/client.rb,
lib/redis/errors.rb,
lib/redis/version.rb,
lib/redis/pipeline.rb,
lib/redis/hash_ring.rb,
lib/redis/subscribe.rb,
lib/redis/distributed.rb
Defined Under Namespace
Classes: BaseConnectionError, BaseError, BasicObject, CannotConnectError, Client, CommandError, ConnectionError, Distributed, Future, FutureNotReady, HashRing, InheritedError, Pipeline, ProtocolError, SubscribedClient, Subscription, TimeoutError
Constant Summary collapse
- VERSION =
"3.0.3"
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Class Method Summary collapse
-
.connect(options = {}) ⇒ Object
deprecated
Deprecated.
The preferred way to create a new client object is using
#new
. This method does not actually establish a connection to Redis, in contrary to what you might expect. - .current ⇒ Object
- .current=(redis) ⇒ Object
- .deprecate(message, trace = caller[0]) ⇒ Object
Instance Method Summary collapse
- #_bpop(cmd, args) ⇒ Object
- #_eval(cmd, args) ⇒ Object
-
#append(key, value) ⇒ Fixnum
Append a value to a key.
-
#auth(password) ⇒ 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)) ⇒ Fixnum
Count the number of set bits in a range of the string value stored at key.
-
#bitop(operation, destkey, *keys) ⇒ Fixnum
Perform a bitwise operation between strings and store the resulting string in a key.
-
#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, options = {}) ⇒ nil, String
Pop a value from a list, push it to another list and return it; or block until one is available.
-
#config(action, *args) ⇒ String, Hash
Get or set server configuration parameters.
-
#dbsize ⇒ Fixnum
Return the number of keys in the selected database.
- #debug(*args) ⇒ Object
-
#decr(key) ⇒ Fixnum
Decrement the integer value of a key by one.
-
#decrby(key, decrement) ⇒ Fixnum
Decrement the integer value of a key by the given number.
-
#del(*keys) ⇒ Fixnum
Delete one or more keys.
-
#discard ⇒ Object
Discard all commands issued after MULTI.
-
#dump(key) ⇒ String
Return a serialized version of the value stored at a key.
-
#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(key) ⇒ Boolean
Determine if a key 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 ⇒ String
Remove all keys from all databases.
-
#flushdb ⇒ String
Remove all keys from the current database.
-
#get(key) ⇒ String
(also: #[])
Get the value of a key.
-
#getbit(key, offset) ⇒ Fixnum
Returns the bit value at offset in the string value stored at key.
-
#getrange(key, start, stop) ⇒ Fixnum
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, field) ⇒ Fixnum
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) ⇒ Fixnum
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) ⇒ Fixnum
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) ⇒ Object
Set one or more hash values.
-
#hset(key, field, value) ⇒ Boolean
Set the string value of a hash field.
-
#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) ⇒ Fixnum
Increment the integer value of a key by one.
-
#incrby(key, increment) ⇒ Fixnum
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
A new instance of Redis.
- #inspect ⇒ Object
-
#keys(pattern = "*") ⇒ Array<String>
Find all keys matching the given pattern.
-
#lastsave ⇒ Fixnum
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) ⇒ Fixnum
Insert an element before or after another element in a list.
-
#llen(key) ⇒ Fixnum
Get the length of a list.
-
#lpop(key) ⇒ String
Remove and get the first element in a list.
-
#lpush(key, value) ⇒ Fixnum
Prepend one or more values to a list, creating the list if it doesn't exist.
-
#lpushx(key, value) ⇒ Fixnum
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) ⇒ Fixnum
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) ⇒ Object
Set one or more hash values.
-
#mapped_mget(*keys) ⇒ Hash
Get the values of all the given keys.
-
#mapped_mset(hash) ⇒ Object
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
-
#mget(*keys, &blk) ⇒ Array<String>
Get the values of all the given keys.
-
#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) ⇒ Object
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.
-
#ping ⇒ String
Ping the server.
- #pipelined ⇒ Object
-
#psetex(key, ttl, value) ⇒ Object
Set the time to live in milliseconds of a key.
-
#psubscribe(*channels, &block) ⇒ Object
Listen for messages published to channels matching the given patterns.
-
#pttl(key) ⇒ Fixnum
Get the time to live (in milliseconds) for a key.
-
#publish(channel, message) ⇒ Object
Post a message to a channel.
-
#punsubscribe(*channels) ⇒ Object
Stop listening for messages posted to channels matching the given patterns.
-
#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) ⇒ Object
Create a key using the serialized value, previously obtained using DUMP.
-
#rpop(key) ⇒ String
Remove and get the last element 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) ⇒ Fixnum
Append one or more values to a list, creating the list if it doesn't exist.
-
#rpushx(key, value) ⇒ Fixnum
Append a value to a list, only if the list exists.
-
#sadd(key, member) ⇒ Boolean, Fixnum
Add one or more members to a set.
-
#save ⇒ String
Synchronously save the dataset to disk.
-
#scard(key) ⇒ Fixnum
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) ⇒ Fixnum
Subtract multiple sets and store the resulting set in a key.
-
#select(db) ⇒ String
Change the selected database for the current connection.
-
#set(key, value) ⇒ Object
(also: #[]=)
Set the string value of a key.
-
#setbit(key, offset, value) ⇒ Fixnum
Sets or clears the bit at offset in the string value stored at key.
-
#setex(key, ttl, value) ⇒ Object
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) ⇒ Fixnum
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) ⇒ Fixnum
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, options = {}) ⇒ Array<String>, ...
Sort the elements in a list, set or sorted set.
-
#spop(key) ⇒ String
Remove and return a random member from a set.
-
#srandmember(key, count = nil) ⇒ String
Get one or more random members from a set.
-
#srem(key, member) ⇒ Boolean, Fixnum
Remove one or more members from a set.
-
#strlen(key) ⇒ Fixnum
Get the length of the value stored in a key.
-
#subscribe(*channels, &block) ⇒ Object
Listen for messages published to the given channels.
- #subscribed? ⇒ Boolean
-
#sunion(*keys) ⇒ Array<String>
Add multiple sets.
-
#sunionstore(destination, *keys) ⇒ Fixnum
Add multiple sets and store the resulting set in a key.
-
#sync ⇒ Object
Internal command used for replication.
- #synchronize ⇒ Object
-
#time ⇒ Array<Fixnum>
Return the server time.
-
#ttl(key) ⇒ Fixnum
Get the time to live (in seconds) for a key.
-
#type(key) ⇒ String
Determine the type stored at key.
-
#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.
-
#zadd(key, *args) ⇒ Boolean, Fixnum
Add one or more members to a sorted set, or update the score for members that already exist.
-
#zcard(key) ⇒ Fixnum
Get the number of members in a sorted set.
-
#zcount(key, min, max) ⇒ Fixnum
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, options = {}) ⇒ Fixnum
Intersect multiple sorted sets and store the resulting sorted set in a new key.
-
#zrange(key, start, stop, options = {}) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by index.
-
#zrangebyscore(key, min, max, options = {}) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by score.
-
#zrank(key, member) ⇒ Fixnum
Determine the index of a member in a sorted set.
-
#zrem(key, member) ⇒ Boolean, Fixnum
Remove one or more members from a sorted set.
-
#zremrangebyrank(key, start, stop) ⇒ Fixnum
Remove all members in a sorted set within the given indexes.
-
#zremrangebyscore(key, min, max) ⇒ Fixnum
Remove all members in a sorted set within the given scores.
-
#zrevrange(key, start, stop, options = {}) ⇒ Object
Return a range of members in a sorted set, by index, with scores ordered from high to low.
-
#zrevrangebyscore(key, max, min, options = {}) ⇒ Object
Return a range of members in a sorted set, by score, with scores ordered from high to low.
-
#zrevrank(key, member) ⇒ Fixnum
Determine the index of a member in a sorted set, with scores ordered from high to low.
-
#zscore(key, member) ⇒ Float
Get the score associated with the given member in a sorted set.
-
#zunionstore(destination, keys, options = {}) ⇒ Fixnum
Add multiple sorted sets and store the resulting sorted set in a new key.
Constructor Details
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(command, *args) ⇒ Object
2236 2237 2238 2239 2240 |
# File 'lib/redis.rb', line 2236 def method_missing(command, *args) synchronize do |client| client.call([command] + args) end end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
10 11 12 |
# File 'lib/redis.rb', line 10 def client @client end |
Class Method Details
.connect(options = {}) ⇒ Object
The preferred way to create a new client object is using #new
.
This method does not actually establish a connection to Redis,
in contrary to what you might expect.
15 16 17 |
# File 'lib/redis.rb', line 15 def self.connect( = {}) new() end |
.current ⇒ Object
19 20 21 |
# File 'lib/redis.rb', line 19 def self.current @current ||= Redis.new end |
.current=(redis) ⇒ Object
23 24 25 |
# File 'lib/redis.rb', line 23 def self.current=(redis) @current = redis end |
.deprecate(message, trace = caller[0]) ⇒ Object
6 7 8 |
# File 'lib/redis.rb', line 6 def self.deprecate(, trace = caller[0]) $stderr.puts "\n#{} (in #{trace})" end |
Instance Method Details
#_bpop(cmd, args) ⇒ Object
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 |
# File 'lib/redis.rb', line 970 def _bpop(cmd, args) = {} case args.last when Hash = args.pop when Integer # Issue deprecation notice in obnoxious mode... [:timeout] = args.pop end if args.size > 1 # Issue deprecation notice in obnoxious mode... end keys = args.flatten timeout = [:timeout] || 0 synchronize do |client| command = [cmd, keys, timeout] timeout += client.timeout if timeout > 0 client.call_with_timeout(command, timeout) end end |
#_eval(cmd, args) ⇒ Object
2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 |
# File 'lib/redis.rb', line 2161 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 |
#append(key, value) ⇒ Fixnum
Append a value to a key.
832 833 834 835 836 |
# File 'lib/redis.rb', line 832 def append(key, value) synchronize do |client| client.call([:append, key, value]) end end |
#auth(password) ⇒ String
Authenticate to the server.
56 57 58 59 60 |
# File 'lib/redis.rb', line 56 def auth(password) synchronize do |client| client.call([:auth, password]) end end |
#bgrewriteaof ⇒ String
Asynchronously rewrite the append-only file.
109 110 111 112 113 |
# File 'lib/redis.rb', line 109 def bgrewriteaof synchronize do |client| client.call([:bgrewriteaof]) end end |
#bgsave ⇒ String
Asynchronously save the dataset to disk.
118 119 120 121 122 |
# File 'lib/redis.rb', line 118 def bgsave synchronize do |client| client.call([:bgsave]) end end |
#bitcount(key, start = 0, stop = -1)) ⇒ Fixnum
Count the number of set bits in a range of the string value stored at key.
844 845 846 847 848 |
# File 'lib/redis.rb', line 844 def bitcount(key, start = 0, stop = -1) synchronize do |client| client.call([:bitcount, key, start, stop]) end end |
#bitop(operation, destkey, *keys) ⇒ Fixnum
Perform a bitwise operation between strings and store the resulting string in a key.
856 857 858 859 860 |
# File 'lib/redis.rb', line 856 def bitop(operation, destkey, *keys) synchronize do |client| client.call([:bitop, operation, destkey] + keys) end end |
#blpop(*args) ⇒ nil, [String, String]
Remove and get the first element in a list, or block until one is available.
1016 1017 1018 |
# File 'lib/redis.rb', line 1016 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.
1032 1033 1034 |
# File 'lib/redis.rb', line 1032 def brpop(*args) _bpop(:brpop, args) end |
#brpoplpush(source, destination, options = {}) ⇒ nil, String
Pop a value from a list, push it to another list and return it; or block until one is available.
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 |
# File 'lib/redis.rb', line 1047 def brpoplpush(source, destination, = {}) case when Integer # Issue deprecation notice in obnoxious mode... = { :timeout => } end timeout = [:timeout] || 0 synchronize do |client| command = [:brpoplpush, source, destination, timeout] timeout += client.timeout if timeout > 0 client.call_with_timeout(command, timeout) end end |
#config(action, *args) ⇒ String, Hash
Get or set server configuration parameters.
129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/redis.rb', line 129 def config(action, *args) synchronize do |client| client.call([:config, action] + args) do |reply| if reply.kind_of?(Array) && action == :get Hash[reply.each_slice(2).to_a] else reply end end end end |
#dbsize ⇒ Fixnum
Return the number of keys in the selected database.
144 145 146 147 148 |
# File 'lib/redis.rb', line 144 def dbsize synchronize do |client| client.call([:dbsize]) end end |
#debug(*args) ⇒ Object
150 151 152 153 154 |
# File 'lib/redis.rb', line 150 def debug(*args) synchronize do |client| client.call([:debug] + args) end end |
#decr(key) ⇒ Fixnum
Decrement the integer value of a key by one.
556 557 558 559 560 |
# File 'lib/redis.rb', line 556 def decr(key) synchronize do |client| client.call([:decr, key]) end end |
#decrby(key, decrement) ⇒ Fixnum
Decrement the integer value of a key by the given number.
571 572 573 574 575 |
# File 'lib/redis.rb', line 571 def decrby(key, decrement) synchronize do |client| client.call([:decrby, key, decrement]) end end |
#del(*keys) ⇒ Fixnum
Delete one or more keys.
388 389 390 391 392 |
# File 'lib/redis.rb', line 388 def del(*keys) synchronize do |client| client.call([:del] + keys) end end |
#discard ⇒ Object
Discard all commands issued after MULTI.
Only call this method when #multi
was called without a block.
2107 2108 2109 2110 2111 |
# File 'lib/redis.rb', line 2107 def discard synchronize do |client| client.call([:discard]) end end |
#dump(key) ⇒ String
Return a serialized version of the value stored at a key.
366 367 368 369 370 |
# File 'lib/redis.rb', line 366 def dump(key) synchronize do |client| client.call([:dump, key]) end end |
#echo(value) ⇒ String
Echo the given string.
86 87 88 89 90 |
# File 'lib/redis.rb', line 86 def echo(value) synchronize do |client| client.call([:echo, value]) end end |
#eval(*args) ⇒ Object
Evaluate Lua script.
2195 2196 2197 |
# File 'lib/redis.rb', line 2195 def eval(*args) _eval(:eval, args) end |
#evalsha(*args) ⇒ Object
Evaluate Lua script by its SHA.
2220 2221 2222 |
# File 'lib/redis.rb', line 2220 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.
2093 2094 2095 2096 2097 |
# File 'lib/redis.rb', line 2093 def exec synchronize do |client| client.call([:exec]) end end |
#exists(key) ⇒ Boolean
Determine if a key exists.
398 399 400 401 402 |
# File 'lib/redis.rb', line 398 def exists(key) synchronize do |client| client.call([:exists, key], &_boolify) end end |
#expire(key, seconds) ⇒ Boolean
Set a key's time to live in seconds.
301 302 303 304 305 |
# File 'lib/redis.rb', line 301 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.
312 313 314 315 316 |
# File 'lib/redis.rb', line 312 def expireat(key, unix_time) synchronize do |client| client.call([:expireat, key, unix_time], &_boolify) end end |
#flushall ⇒ String
Remove all keys from all databases.
159 160 161 162 163 |
# File 'lib/redis.rb', line 159 def flushall synchronize do |client| client.call([:flushall]) end end |
#flushdb ⇒ String
Remove all keys from the current database.
168 169 170 171 172 |
# File 'lib/redis.rb', line 168 def flushdb synchronize do |client| client.call([:flushdb]) end end |
#get(key) ⇒ String Also known as: []
Get the value of a key.
735 736 737 738 739 |
# File 'lib/redis.rb', line 735 def get(key) synchronize do |client| client.call([:get, key]) end end |
#getbit(key, offset) ⇒ Fixnum
Returns the bit value at offset in the string value stored at key.
821 822 823 824 825 |
# File 'lib/redis.rb', line 821 def getbit(key, offset) synchronize do |client| client.call([:getbit, key, offset]) end end |
#getrange(key, start, stop) ⇒ Fixnum
Get a substring of the string stored at a key.
798 799 800 801 802 |
# File 'lib/redis.rb', line 798 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.
868 869 870 871 872 |
# File 'lib/redis.rb', line 868 def getset(key, value) synchronize do |client| client.call([:getset, key, value.to_s]) end end |
#hdel(key, field) ⇒ Fixnum
Delete one or more hash fields.
1849 1850 1851 1852 1853 |
# File 'lib/redis.rb', line 1849 def hdel(key, field) synchronize do |client| client.call([:hdel, key, field]) end end |
#hexists(key, field) ⇒ Boolean
Determine if a hash field exists.
1860 1861 1862 1863 1864 |
# File 'lib/redis.rb', line 1860 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.
1800 1801 1802 1803 1804 |
# File 'lib/redis.rb', line 1800 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.
1916 1917 1918 1919 1920 |
# File 'lib/redis.rb', line 1916 def hgetall(key) synchronize do |client| client.call([:hgetall, key], &_hashify) end end |
#hincrby(key, field, increment) ⇒ Fixnum
Increment the integer value of a hash field by the given integer number.
1872 1873 1874 1875 1876 |
# File 'lib/redis.rb', line 1872 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.
1884 1885 1886 1887 1888 1889 1890 |
# File 'lib/redis.rb', line 1884 def hincrbyfloat(key, field, increment) synchronize do |client| client.call([:hincrbyfloat, key, field, increment]) do |reply| _floatify(reply) if reply end end end |
#hkeys(key) ⇒ Array<String>
Get all the fields in a hash.
1896 1897 1898 1899 1900 |
# File 'lib/redis.rb', line 1896 def hkeys(key) synchronize do |client| client.call([:hkeys, key]) end end |
#hlen(key) ⇒ Fixnum
Get the number of fields in a hash.
1733 1734 1735 1736 1737 |
# File 'lib/redis.rb', line 1733 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.
1817 1818 1819 1820 1821 |
# File 'lib/redis.rb', line 1817 def hmget(key, *fields, &blk) synchronize do |client| client.call([:hmget, key] + fields, &blk) end end |
#hmset(key, *attrs) ⇒ Object
Set one or more hash values.
1774 1775 1776 1777 1778 |
# File 'lib/redis.rb', line 1774 def hmset(key, *attrs) synchronize do |client| client.call([:hmset, key] + attrs) end end |
#hset(key, field, value) ⇒ Boolean
Set the string value of a hash field.
1745 1746 1747 1748 1749 |
# File 'lib/redis.rb', line 1745 def hset(key, field, value) synchronize do |client| client.call([:hset, key, field, value], &_boolify) end end |
#hsetnx(key, field, value) ⇒ Boolean
Set the value of a hash field, only if the field does not exist.
1757 1758 1759 1760 1761 |
# File 'lib/redis.rb', line 1757 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.
1906 1907 1908 1909 1910 |
# File 'lib/redis.rb', line 1906 def hvals(key) synchronize do |client| client.call([:hvals, key]) end end |
#id ⇒ Object
2224 2225 2226 2227 2228 |
# File 'lib/redis.rb', line 2224 def id synchronize do |client| client.id end end |
#incr(key) ⇒ Fixnum
Increment the integer value of a key by one.
585 586 587 588 589 |
# File 'lib/redis.rb', line 585 def incr(key) synchronize do |client| client.call([:incr, key]) end end |
#incrby(key, increment) ⇒ Fixnum
Increment the integer value of a key by the given integer number.
600 601 602 603 604 |
# File 'lib/redis.rb', line 600 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.
615 616 617 618 619 620 621 |
# File 'lib/redis.rb', line 615 def incrbyfloat(key, increment) synchronize do |client| client.call([:incrbyfloat, key, increment]) do |reply| _floatify(reply) if reply end end end |
#info(cmd = nil) ⇒ Hash<String, String>
Get information and statistics about the server.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/redis.rb', line 178 def info(cmd = nil) synchronize do |client| client.call([:info, cmd].compact) do |reply| if reply.kind_of?(String) reply = Hash[reply.split("\r\n").map do |line| line.split(":", 2) unless line =~ /^(#|$)/ end.compact] 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
2230 2231 2232 2233 2234 |
# File 'lib/redis.rb', line 2230 def inspect synchronize do |client| "#<Redis client v#{Redis::VERSION} for #{client.id}>" end end |
#keys(pattern = "*") ⇒ Array<String>
Find all keys matching the given pattern.
408 409 410 411 412 413 414 415 416 417 418 |
# File 'lib/redis.rb', line 408 def keys(pattern = "*") synchronize do |client| client.call([:keys, pattern]) do |reply| if reply.kind_of?(String) reply.split(" ") else reply end end end end |
#lastsave ⇒ Fixnum
Get the UNIX time stamp of the last successful save to disk.
203 204 205 206 207 |
# File 'lib/redis.rb', line 203 def lastsave synchronize do |client| client.call([:lastsave]) end end |
#lindex(key, index) ⇒ String
Get an element from a list by its index.
1068 1069 1070 1071 1072 |
# File 'lib/redis.rb', line 1068 def lindex(key, index) synchronize do |client| client.call([:lindex, key, index]) end end |
#linsert(key, where, pivot, value) ⇒ Fixnum
Insert an element before or after another element in a list.
1082 1083 1084 1085 1086 |
# File 'lib/redis.rb', line 1082 def linsert(key, where, pivot, value) synchronize do |client| client.call([:linsert, key, where, pivot, value]) end end |
#llen(key) ⇒ Fixnum
Get the length of a list.
889 890 891 892 893 |
# File 'lib/redis.rb', line 889 def llen(key) synchronize do |client| client.call([:llen, key]) end end |
#lpop(key) ⇒ String
Remove and get the first element in a list.
943 944 945 946 947 |
# File 'lib/redis.rb', line 943 def lpop(key) synchronize do |client| client.call([:lpop, key]) end end |
#lpush(key, value) ⇒ Fixnum
Prepend one or more values to a list, creating the list if it doesn't exist
900 901 902 903 904 |
# File 'lib/redis.rb', line 900 def lpush(key, value) synchronize do |client| client.call([:lpush, key, value]) end end |
#lpushx(key, value) ⇒ Fixnum
Prepend a value to a list, only if the list exists.
911 912 913 914 915 |
# File 'lib/redis.rb', line 911 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.
1094 1095 1096 1097 1098 |
# File 'lib/redis.rb', line 1094 def lrange(key, start, stop) synchronize do |client| client.call([:lrange, key, start, stop]) end end |
#lrem(key, count, value) ⇒ Fixnum
Remove elements from a list.
1109 1110 1111 1112 1113 |
# File 'lib/redis.rb', line 1109 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.
1121 1122 1123 1124 1125 |
# File 'lib/redis.rb', line 1121 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.
1133 1134 1135 1136 1137 |
# File 'lib/redis.rb', line 1133 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.
1834 1835 1836 1837 1838 1839 1840 1841 1842 |
# File 'lib/redis.rb', line 1834 def mapped_hmget(key, *fields) hmget(key, *fields) do |reply| if reply.kind_of?(Array) Hash[fields.zip(reply)] else reply end end end |
#mapped_hmset(key, hash) ⇒ Object
Set one or more hash values.
1791 1792 1793 |
# File 'lib/redis.rb', line 1791 def mapped_hmset(key, hash) hmset(key, hash.to_a.flatten) end |
#mapped_mget(*keys) ⇒ Hash
Get the values of all the given keys.
769 770 771 772 773 774 775 776 777 |
# File 'lib/redis.rb', line 769 def mapped_mget(*keys) mget(*keys) do |reply| if reply.kind_of?(Array) Hash[keys.zip(reply)] else reply end end end |
#mapped_mset(hash) ⇒ Object
Set one or more values.
697 698 699 |
# File 'lib/redis.rb', line 697 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.
727 728 729 |
# File 'lib/redis.rb', line 727 def mapped_msetnx(hash) msetnx(hash.to_a.flatten) end |
#mget(*keys, &blk) ⇒ Array<String>
Get the values of all the given keys.
753 754 755 756 757 |
# File 'lib/redis.rb', line 753 def mget(*keys, &blk) synchronize do |client| client.call([:mget] + keys, &blk) end end |
#monitor {|line| ... } ⇒ Object
Listen for all requests received by the server in real time.
There is no way to interrupt this command.
215 216 217 218 219 |
# File 'lib/redis.rb', line 215 def monitor(&block) synchronize do |client| client.call_loop([:monitor], &block) end end |
#move(key, db) ⇒ Boolean
Move a key to another database.
439 440 441 442 443 |
# File 'lib/redis.rb', line 439 def move(key, db) synchronize do |client| client.call([:move, key, db], &_boolify) end end |
#mset(*args) ⇒ Object
Set one or more values.
681 682 683 684 685 |
# File 'lib/redis.rb', line 681 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.
711 712 713 714 715 |
# File 'lib/redis.rb', line 711 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.
2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 |
# File 'lib/redis.rb', line 2066 def multi synchronize do |client| if !block_given? client.call([:multi]) else begin pipeline = Pipeline::Multi.new original, @client = @client, pipeline yield(self) original.call_pipeline(pipeline) ensure @client = original end end end end |
#object(*args) ⇒ Object
445 446 447 448 449 |
# File 'lib/redis.rb', line 445 def object(*args) synchronize do |client| client.call([:object] + args) end end |
#persist(key) ⇒ Boolean
Remove the expiration from a key.
290 291 292 293 294 |
# File 'lib/redis.rb', line 290 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.
334 335 336 337 338 |
# File 'lib/redis.rb', line 334 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.
345 346 347 348 349 |
# File 'lib/redis.rb', line 345 def pexpireat(key, ms_unix_time) synchronize do |client| client.call([:pexpireat, key, ms_unix_time], &_boolify) end end |
#ping ⇒ String
Ping the server.
76 77 78 79 80 |
# File 'lib/redis.rb', line 76 def ping synchronize do |client| client.call([:ping]) end end |
#pipelined ⇒ Object
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/redis.rb', line 2024 def pipelined synchronize do |client| begin original, @client = @client, Pipeline.new yield(self) original.call_pipeline(@client) ensure @client = original end end end |
#psetex(key, ttl, value) ⇒ Object
Set the time to live in milliseconds of a key.
654 655 656 657 658 |
# File 'lib/redis.rb', line 654 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.
1951 1952 1953 1954 1955 |
# File 'lib/redis.rb', line 1951 def psubscribe(*channels, &block) synchronize do |client| _subscription(:psubscribe, channels, block) end end |
#pttl(key) ⇒ Fixnum
Get the time to live (in milliseconds) for a key.
356 357 358 359 360 |
# File 'lib/redis.rb', line 356 def pttl(key) synchronize do |client| client.call([:pttl, key]) end end |
#publish(channel, message) ⇒ Object
Post a message to a channel.
1923 1924 1925 1926 1927 |
# File 'lib/redis.rb', line 1923 def publish(channel, ) synchronize do |client| client.call([:publish, channel, ]) end end |
#punsubscribe(*channels) ⇒ Object
Stop listening for messages posted to channels matching the given patterns.
1958 1959 1960 1961 1962 1963 |
# File 'lib/redis.rb', line 1958 def punsubscribe(*channels) synchronize do |client| raise RuntimeError, "Can't unsubscribe if not subscribed." unless subscribed? client.punsubscribe(*channels) end end |
#quit ⇒ String
Close the connection.
95 96 97 98 99 100 101 102 103 104 |
# File 'lib/redis.rb', line 95 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.
454 455 456 457 458 |
# File 'lib/redis.rb', line 454 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.
465 466 467 468 469 |
# File 'lib/redis.rb', line 465 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.
476 477 478 479 480 |
# File 'lib/redis.rb', line 476 def renamenx(old_name, new_name) synchronize do |client| client.call([:renamenx, old_name, new_name], &_boolify) end end |
#restore(key, ttl, serialized_value) ⇒ Object
Create a key using the serialized value, previously obtained using DUMP.
378 379 380 381 382 |
# File 'lib/redis.rb', line 378 def restore(key, ttl, serialized_value) synchronize do |client| client.call([:restore, key, ttl, serialized_value]) end end |
#rpop(key) ⇒ String
Remove and get the last element in a list.
953 954 955 956 957 |
# File 'lib/redis.rb', line 953 def rpop(key) synchronize do |client| client.call([:rpop, key]) end end |
#rpoplpush(source, destination) ⇒ nil, String
Remove the last element in a list, append it to another list and return it.
964 965 966 967 968 |
# File 'lib/redis.rb', line 964 def rpoplpush(source, destination) synchronize do |client| client.call([:rpoplpush, source, destination]) end end |
#rpush(key, value) ⇒ Fixnum
Append one or more values to a list, creating the list if it doesn't exist
922 923 924 925 926 |
# File 'lib/redis.rb', line 922 def rpush(key, value) synchronize do |client| client.call([:rpush, key, value]) end end |
#rpushx(key, value) ⇒ Fixnum
Append a value to a list, only if the list exists.
933 934 935 936 937 |
# File 'lib/redis.rb', line 933 def rpushx(key, value) synchronize do |client| client.call([:rpushx, key, value]) end end |
#sadd(key, member) ⇒ Boolean, Fixnum
Add one or more members to a set.
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 |
# File 'lib/redis.rb', line 1157 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.
224 225 226 227 228 |
# File 'lib/redis.rb', line 224 def save synchronize do |client| client.call([:save]) end end |
#scard(key) ⇒ Fixnum
Get the number of members in a set.
1143 1144 1145 1146 1147 |
# File 'lib/redis.rb', line 1143 def scard(key) synchronize do |client| client.call([:scard, key]) end end |
#script(subcommand, *args) ⇒ String, ...
Control remote script registry.
2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 |
# File 'lib/redis.rb', line 2137 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.
1255 1256 1257 1258 1259 |
# File 'lib/redis.rb', line 1255 def sdiff(*keys) synchronize do |client| client.call([:sdiff] + keys) end end |
#sdiffstore(destination, *keys) ⇒ Fixnum
Subtract multiple sets and store the resulting set in a key.
1266 1267 1268 1269 1270 |
# File 'lib/redis.rb', line 1266 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.
66 67 68 69 70 71 |
# File 'lib/redis.rb', line 66 def select(db) synchronize do |client| client.db = db client.call([:select, db]) end end |
#set(key, value) ⇒ Object Also known as: []=
Set the string value of a key.
628 629 630 631 632 |
# File 'lib/redis.rb', line 628 def set(key, value) synchronize do |client| client.call([:set, key, value.to_s]) end end |
#setbit(key, offset, value) ⇒ Fixnum
Sets or clears the bit at offset in the string value stored at key.
810 811 812 813 814 |
# File 'lib/redis.rb', line 810 def setbit(key, offset, value) synchronize do |client| client.call([:setbit, key, offset, value]) end end |
#setex(key, ttl, value) ⇒ Object
Set the time to live in seconds of a key.
642 643 644 645 646 |
# File 'lib/redis.rb', line 642 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.
665 666 667 668 669 |
# File 'lib/redis.rb', line 665 def setnx(key, value) synchronize do |client| client.call([:setnx, key, value.to_s], &_boolify) end end |
#setrange(key, offset, value) ⇒ Fixnum
Overwrite part of a string at key starting at the specified offset.
785 786 787 788 789 |
# File 'lib/redis.rb', line 785 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.
231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/redis.rb', line 231 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.
1276 1277 1278 1279 1280 |
# File 'lib/redis.rb', line 1276 def sinter(*keys) synchronize do |client| client.call([:sinter] + keys) end end |
#sinterstore(destination, *keys) ⇒ Fixnum
Intersect multiple sets and store the resulting set in a key.
1287 1288 1289 1290 1291 |
# File 'lib/redis.rb', line 1287 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.
1235 1236 1237 1238 1239 |
# File 'lib/redis.rb', line 1235 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.
245 246 247 248 249 |
# File 'lib/redis.rb', line 245 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)
256 257 258 259 260 261 262 |
# File 'lib/redis.rb', line 256 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.
1245 1246 1247 1248 1249 |
# File 'lib/redis.rb', line 1245 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.
1224 1225 1226 1227 1228 |
# File 'lib/redis.rb', line 1224 def smove(source, destination, member) synchronize do |client| client.call([:smove, source, destination, member], &_boolify) end end |
#sort(key, options = {}) ⇒ Array<String>, ...
Sort the elements in a list, set or sorted set.
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 |
# File 'lib/redis.rb', line 507 def sort(key, = {}) args = [] by = [:by] args.concat(["BY", by]) if by limit = [:limit] args.concat(["LIMIT"] + limit) if limit get = Array([:get]) args.concat(["GET"].product(get).flatten) unless get.empty? order = [:order] args.concat(order.split(" ")) if order store = [:store] args.concat(["STORE", store]) if store synchronize do |client| client.call([:sort, key] + args) do |reply| if get.size > 1 if reply reply.each_slice(get.size).to_a end else reply end end end end |
#spop(key) ⇒ String
Remove and return a random member from a set.
1197 1198 1199 1200 1201 |
# File 'lib/redis.rb', line 1197 def spop(key) synchronize do |client| client.call([:spop, key]) end end |
#srandmember(key, count = nil) ⇒ String
Get one or more random members from a set.
1208 1209 1210 1211 1212 1213 1214 1215 1216 |
# File 'lib/redis.rb', line 1208 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, Fixnum
Remove one or more members from a set.
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 |
# File 'lib/redis.rb', line 1179 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 |
#strlen(key) ⇒ Fixnum
Get the length of the value stored in a key.
879 880 881 882 883 |
# File 'lib/redis.rb', line 879 def strlen(key) synchronize do |client| client.call([:strlen, key]) end end |
#subscribe(*channels, &block) ⇒ Object
Listen for messages published to the given channels.
1936 1937 1938 1939 1940 |
# File 'lib/redis.rb', line 1936 def subscribe(*channels, &block) synchronize do |client| _subscription(:subscribe, channels, block) end end |
#subscribed? ⇒ Boolean
1929 1930 1931 1932 1933 |
# File 'lib/redis.rb', line 1929 def subscribed? synchronize do |client| client.kind_of? SubscribedClient end end |
#sunion(*keys) ⇒ Array<String>
Add multiple sets.
1297 1298 1299 1300 1301 |
# File 'lib/redis.rb', line 1297 def sunion(*keys) synchronize do |client| client.call([:sunion] + keys) end end |
#sunionstore(destination, *keys) ⇒ Fixnum
Add multiple sets and store the resulting set in a key.
1308 1309 1310 1311 1312 |
# File 'lib/redis.rb', line 1308 def sunionstore(destination, *keys) synchronize do |client| client.call([:sunionstore, destination] + keys) end end |
#sync ⇒ Object
Internal command used for replication.
265 266 267 268 269 |
# File 'lib/redis.rb', line 265 def sync synchronize do |client| client.call([:sync]) end end |
#synchronize ⇒ Object
35 36 37 |
# File 'lib/redis.rb', line 35 def synchronize mon_synchronize { yield(@client) } end |
#time ⇒ Array<Fixnum>
Return the server time.
278 279 280 281 282 283 284 |
# File 'lib/redis.rb', line 278 def time synchronize do |client| client.call([:time]) do |reply| reply.map(&:to_i) if reply end end end |
#ttl(key) ⇒ Fixnum
Get the time to live (in seconds) for a key.
323 324 325 326 327 |
# File 'lib/redis.rb', line 323 def ttl(key) synchronize do |client| client.call([:ttl, key]) end end |
#type(key) ⇒ String
Determine the type stored at key.
542 543 544 545 546 |
# File 'lib/redis.rb', line 542 def type(key) synchronize do |client| client.call([:type, key]) end end |
#unsubscribe(*channels) ⇒ Object
Stop listening for messages posted to the given channels.
1943 1944 1945 1946 1947 1948 |
# File 'lib/redis.rb', line 1943 def unsubscribe(*channels) synchronize do |client| raise RuntimeError, "Can't unsubscribe if not subscribed." unless subscribed? client.unsubscribe(*channels) end end |
#unwatch ⇒ String
Forget about all watched keys.
2018 2019 2020 2021 2022 |
# File 'lib/redis.rb', line 2018 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.
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 |
# File 'lib/redis.rb', line 1995 def watch(*keys) synchronize do |client| client.call([:watch] + keys) if block_given? begin yield(self) rescue ConnectionError raise rescue StandardError unwatch raise end end end end |
#with_reconnect(val = true, &blk) ⇒ Object
Run code with the client reconnecting
40 41 42 43 44 |
# File 'lib/redis.rb', line 40 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
47 48 49 |
# File 'lib/redis.rb', line 47 def without_reconnect(&blk) with_reconnect(false, &blk) end |
#zadd(key, *args) ⇒ Boolean, Fixnum
Add one or more members to a sorted set, or update the score for members that already exist.
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 |
# File 'lib/redis.rb', line 1346 def zadd(key, *args) synchronize do |client| if args.size == 1 && args[0].is_a?(Array) # Variadic: return integer client.call([:zadd, key] + args[0]) elsif args.size == 2 # Single pair: return boolean client.call([:zadd, key, args[0], args[1]], &_boolify) else raise ArgumentError, "wrong number of arguments" end end end |
#zcard(key) ⇒ Fixnum
Get the number of members in a sorted set.
1322 1323 1324 1325 1326 |
# File 'lib/redis.rb', line 1322 def zcard(key) synchronize do |client| client.call([:zcard, key]) end end |
#zcount(key, min, max) ⇒ Fixnum
Count the members in a sorted set with scores within the given values.
1668 1669 1670 1671 1672 |
# File 'lib/redis.rb', line 1668 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.
1370 1371 1372 1373 1374 1375 1376 |
# File 'lib/redis.rb', line 1370 def zincrby(key, increment, member) synchronize do |client| client.call([:zincrby, key, increment, member]) do |reply| _floatify(reply) if reply end end end |
#zinterstore(destination, keys, options = {}) ⇒ Fixnum
Intersect multiple sorted sets and store the resulting sorted set in a new key.
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'lib/redis.rb', line 1688 def zinterstore(destination, keys, = {}) args = [] weights = [:weights] args.concat(["WEIGHTS"] + weights) if weights aggregate = [:aggregate] args.concat(["AGGREGATE", aggregate]) if aggregate synchronize do |client| client.call([:zinterstore, destination, keys.size] + keys + args) end end |
#zrange(key, start, stop, options = {}) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by index.
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 |
# File 'lib/redis.rb', line 1444 def zrange(key, start, stop, = {}) args = [] with_scores = [:with_scores] || [:withscores] args << "WITHSCORES" if with_scores synchronize do |client| client.call([:zrange, key, start, stop] + args) do |reply| if with_scores if reply reply.each_slice(2).map do |member, score| [member, _floatify(score)] end end else reply end end end end |
#zrangebyscore(key, min, max, options = {}) ⇒ Array<String>, Array<[String, Float]>
Return a range of members in a sorted set, by score.
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 |
# File 'lib/redis.rb', line 1566 def zrangebyscore(key, min, max, = {}) args = [] with_scores = [:with_scores] || [:withscores] args.concat(["WITHSCORES"]) if with_scores limit = [:limit] args.concat(["LIMIT"] + limit) if limit synchronize do |client| client.call([:zrangebyscore, key, min, max] + args) do |reply| if with_scores if reply reply.each_slice(2).map do |member, score| [member, _floatify(score)] end end else reply end end end end |
#zrank(key, member) ⇒ Fixnum
Determine the index of a member in a sorted set.
1502 1503 1504 1505 1506 |
# File 'lib/redis.rb', line 1502 def zrank(key, member) synchronize do |client| client.call([:zrank, key, member]) end end |
#zrem(key, member) ⇒ Boolean, Fixnum
Remove one or more members from a sorted set.
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 |
# File 'lib/redis.rb', line 1395 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) ⇒ Fixnum
Remove all members in a sorted set within the given indexes.
1533 1534 1535 1536 1537 |
# File 'lib/redis.rb', line 1533 def zremrangebyrank(key, start, stop) synchronize do |client| client.call([:zremrangebyrank, key, start, stop]) end end |
#zremrangebyscore(key, min, max) ⇒ Fixnum
Remove all members in a sorted set within the given scores.
1645 1646 1647 1648 1649 |
# File 'lib/redis.rb', line 1645 def zremrangebyscore(key, min, max) synchronize do |client| client.call([:zremrangebyscore, key, min, max]) end end |
#zrevrange(key, start, stop, options = {}) ⇒ Object
Return a range of members in a sorted set, by index, with scores ordered from high to low.
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 |
# File 'lib/redis.rb', line 1476 def zrevrange(key, start, stop, = {}) args = [] with_scores = [:with_scores] || [:withscores] args << "WITHSCORES" if with_scores synchronize do |client| client.call([:zrevrange, key, start, stop] + args) do |reply| if with_scores if reply reply.each_slice(2).map do |member, score| [member, _floatify(score)] end end else reply end end end end |
#zrevrangebyscore(key, max, min, options = {}) ⇒ Object
Return a range of members in a sorted set, by score, with scores ordered from high to low.
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'lib/redis.rb', line 1604 def zrevrangebyscore(key, max, min, = {}) args = [] with_scores = [:with_scores] || [:withscores] args.concat(["WITHSCORES"]) if with_scores limit = [:limit] args.concat(["LIMIT"] + limit) if limit synchronize do |client| client.call([:zrevrangebyscore, key, max, min] + args) do |reply| if with_scores if reply reply.each_slice(2).map do |member, score| [member, _floatify(score)] end end else reply end end end end |
#zrevrank(key, member) ⇒ Fixnum
Determine the index of a member in a sorted set, with scores ordered from high to low.
1514 1515 1516 1517 1518 |
# File 'lib/redis.rb', line 1514 def zrevrank(key, member) synchronize do |client| client.call([:zrevrank, key, member]) end end |
#zscore(key, member) ⇒ Float
Get the score associated with the given member in a sorted set.
1418 1419 1420 1421 1422 1423 1424 |
# File 'lib/redis.rb', line 1418 def zscore(key, member) synchronize do |client| client.call([:zscore, key, member]) do |reply| _floatify(reply) if reply end end end |
#zunionstore(destination, keys, options = {}) ⇒ Fixnum
Add multiple sorted sets and store the resulting sorted set in a new key.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 |
# File 'lib/redis.rb', line 1715 def zunionstore(destination, keys, = {}) args = [] weights = [:weights] args.concat(["WEIGHTS"] + weights) if weights aggregate = [:aggregate] args.concat(["AGGREGATE", aggregate]) if aggregate synchronize do |client| client.call([:zunionstore, destination, keys.size] + keys + args) end end |