Class: Redis

Inherits:
Object
  • Object
show all
Defined in:
lib/redis.rb,
lib/pipeline.rb

Direct Known Subclasses

Pipeline

Defined Under Namespace

Classes: Pipeline

Constant Summary collapse

OK = 
"OK".freeze
MINUS = 
"-".freeze
PLUS = 
"+".freeze
COLON = 
":".freeze
DOLLAR = 
"$".freeze
ASTERISK = 
"*".freeze
BULK_COMMANDS = 
{
  "set"       => true,
  "setnx"     => true,
  "rpush"     => true,
  "lpush"     => true,
  "lset"      => true,
  "lrem"      => true,
  "sadd"      => true,
  "srem"      => true,
  "sismember" => true,
  "echo"      => true,
  "getset"    => true,
  "smove"     => true
}
BOOLEAN_PROCESSOR = 
lambda{|r| r == 1 }
REPLY_PROCESSOR = 
{
  "exists"    => BOOLEAN_PROCESSOR,
  "sismember" => BOOLEAN_PROCESSOR,
  "sadd"      => BOOLEAN_PROCESSOR,
  "srem"      => BOOLEAN_PROCESSOR,
  "smove"     => BOOLEAN_PROCESSOR,
  "move"      => BOOLEAN_PROCESSOR,
  "setnx"     => BOOLEAN_PROCESSOR,
  "del"       => BOOLEAN_PROCESSOR,
  "renamenx"  => BOOLEAN_PROCESSOR,
  "expire"    => BOOLEAN_PROCESSOR,
  "keys"      => lambda{|r| r.split(" ")},
  "info"      => lambda{|r|
    info = {}
    r.each_line {|kv|
      k,v = kv.split(":",2).map{|x| x.chomp}
      info[k.to_sym] = v
    }
    info
  }
}
ALIASES = 
{
  "flush_db"             => "flushdb",
  "flush_all"            => "flushall",
  "last_save"            => "lastsave",
  "key?"                 => "exists",
  "delete"               => "del",
  "randkey"              => "randomkey",
  "list_length"          => "llen",
  "push_tail"            => "rpush",
  "push_head"            => "lpush",
  "pop_tail"             => "rpop",
  "pop_head"             => "lpop",
  "list_set"             => "lset",
  "list_range"           => "lrange",
  "list_trim"            => "ltrim",
  "list_index"           => "lindex",
  "list_rm"              => "lrem",
  "set_add"              => "sadd",
  "set_delete"           => "srem",
  "set_count"            => "scard",
  "set_member?"          => "sismember",
  "set_members"          => "smembers",
  "set_intersect"        => "sinter",
  "set_intersect_store"  => "sinterstore",
  "set_inter_store"      => "sinterstore",
  "set_union"            => "sunion",
  "set_union_store"      => "sunionstore",
  "set_diff"             => "sdiff",
  "set_diff_store"       => "sdiffstore",
  "set_move"             => "smove",
  "set_unless_exists"    => "setnx",
  "rename_unless_exists" => "renamenx",
  "type?"                => "type"
}
DISABLED_COMMANDS = 
{
  "monitor" => true,
  "sync"    => true
}

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Redis

Returns a new instance of Redis.



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/redis.rb', line 103

def initialize(options = {})
  @host      =  options[:host]    || '127.0.0.1'
  @port      = (options[:port]    || 6379).to_i
  @db        = (options[:db]      || 0).to_i
  @timeout   = (options[:timeout] || 5).to_i
  @password  = options[:password]
  @logger    = options[:logger]
  @namespace = options[:namespace]

  @logger.info { self.to_s } if @logger
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(*argv) ⇒ Object 



158
159
160
 
# File 'lib/redis.rb', line 158

def method_missing(*argv)
  call_command(argv)
end

Instance Method Details

#[](key) ⇒ Object 



223
224
225
 
# File 'lib/redis.rb', line 223

def [](key)
  self.get(key)
end

#[]=(key, value) ⇒ Object 



227
228
229
 
# File 'lib/redis.rb', line 227

def []=(key,value)
  set(key,value)
end

#call_command(argv, use_namespace = true) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/redis.rb', line 162

def call_command(argv, use_namespace = true)
  @logger.debug { argv.inspect } if @logger

  # this wrapper to raw_call_command handle reconnection on socket
  # error. We try to reconnect just one time, otherwise let the error
  # araise.
  connect_to_server if !@sock

  begin
    raw_call_command(argv.dup, use_namespace)
  rescue Errno::ECONNRESET, Errno::EPIPE
    @sock.close
    @sock = nil
    connect_to_server
    raw_call_command(argv.dup)
  end
end

#connect_to(host, port, timeout = nil) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/redis.rb', line 129

def connect_to(host, port, timeout=nil)
  # We support connect() timeout only if system_timer is availabe
  # or if we are running against Ruby >= 1.9
  # Timeout reading from the socket instead will be supported anyway.
  if @timeout != 0 and RedisTimer
    begin
      sock = TCPSocket.new(host, port)
    rescue Timeout::Error
      @sock = nil
      raise Timeout::Error, "Timeout connecting to the server"
    end
  else
    sock = TCPSocket.new(host, port)
  end
  sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1

  # If the timeout is set we set the low level socket options in order
  # to make sure a blocking read will return after the specified number
  # of seconds. This hack is from memcached ruby client.
  if timeout
    secs   = Integer(timeout)
    usecs  = Integer((timeout - secs) * 1_000_000)
    optval = [secs, usecs].pack("l_2")
    sock.setsockopt Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval
    sock.setsockopt Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval
  end
  sock
end

#connect_to_server ⇒ Object 



123
124
125
126
127
 
# File 'lib/redis.rb', line 123

def connect_to_server
  @sock = connect_to(@host, @port, @timeout == 0 ? nil : @timeout)
  call_command(["auth",@password]) if @password
  call_command(["select",@db]) unless @db == 0
end

#decr(key, decrement = nil) ⇒ Object 



251
252
253
 
# File 'lib/redis.rb', line 251

def decr(key,decrement = nil)
  call_command(decrement ? ["decrby",key,decrement] : ["decr",key])
end

#incr(key, increment = nil) ⇒ Object 



247
248
249
 
# File 'lib/redis.rb', line 247

def incr(key, increment = nil)
  call_command(increment ? ["incrby",key,increment] : ["incr",key])
end

#mapped_mget(*keys) ⇒ Object

Similar to memcache.rb’s #get_multi, returns a hash mapping keys to values.



257
258
259
260
261
262
 
# File 'lib/redis.rb', line 257

def mapped_mget(*keys)
  mget(*keys).inject({}) do |hash, value|
    key = keys.shift
    value.nil? ? hash : hash.merge(key => value)
  end
end

#mget(*keys) ⇒ Object 



264
265
266
267
 
# File 'lib/redis.rb', line 264

def mget(*keys)
  keys = keys.map { |key| "#{@namespace}:#{key}"} if @namespace
  call_command([:mget] + keys, false)
end

#pipelined {|pipeline| ... } ⇒ Object

Yields:

  • (pipeline) 


280
281
282
283
284
 
# File 'lib/redis.rb', line 280

def pipelined(&block)
  pipeline = Pipeline.new self
  yield pipeline
  pipeline.execute
end

#quit ⇒ Object 



275
276
277
278
 
# File 'lib/redis.rb', line 275

def quit
  call_command(['quit'])
rescue Errno::ECONNRESET
end

#raw_call_command(argvp, use_namespace = true) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/redis.rb', line 180

def raw_call_command(argvp, use_namespace = true)
  pipeline = argvp[0].is_a?(Array)

  unless pipeline
    argvv = [argvp]
  else
    argvv = argvp
  end

  command = ''

  argvv.each do |argv|
    bulk = nil
    argv[0] = argv[0].to_s.downcase
    argv[0] = ALIASES[argv[0]] if ALIASES[argv[0]]
    raise "#{argv[0]} command is disabled" if DISABLED_COMMANDS[argv[0]]
    if BULK_COMMANDS[argv[0]] and argv.length > 1
      bulk = argv[-1].to_s
      argv[-1] = bulk.respond_to?(:bytesize) ? bulk.bytesize : bulk.size
    end

    if @namespace && argv[1] && use_namespace
      argv[1] = "#{@namespace}:#{argv[1]}"
    end

    command << "#{argv.join(' ')}\r\n"
    command << "#{bulk}\r\n" if bulk
  end

  @sock.write(command)

  results = argvv.map do |argv|
    processor = REPLY_PROCESSOR[argv[0]]
    processor ? processor.call(read_reply) : read_reply
  end

  return pipeline ? results : results[0]
end

#read_reply ⇒ Object

Raises:

  • (Errno::ECONNRESET) 


286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/redis.rb', line 286

def read_reply
  # We read the first byte using read() mainly because gets() is
  # immune to raw socket timeouts.
  begin
    rtype = @sock.read(1)
  rescue Errno::EAGAIN
    # We want to make sure it reconnects on the next command after the
    # timeout. Otherwise the server may reply in the meantime leaving
    # the protocol in a desync status.
    @sock = nil
    raise Errno::EAGAIN, "Timeout reading from the socket"
  end

  raise Errno::ECONNRESET,"Connection lost" if !rtype
  line = @sock.gets
  case rtype
  when MINUS
    raise MINUS + line.strip
  when PLUS
    line.strip
  when COLON
    line.to_i
  when DOLLAR
    bulklen = line.to_i
    return nil if bulklen == -1
    data = @sock.read(bulklen)
    @sock.read(2) # CRLF
    data
  when ASTERISK
    objects = line.to_i
    return nil if bulklen == -1
    res = []
    objects.times {
      res << read_reply
    }
    res
  else
    raise "Protocol error, got '#{rtype}' as initial reply byte"
  end
end

#select(*args) ⇒ Object 



219
220
221
 
# File 'lib/redis.rb', line 219

def select(*args)
  raise "SELECT not allowed, use the :db option when creating the object"
end

#server ⇒ Object 



119
120
121
 
# File 'lib/redis.rb', line 119

def server
  "#{@host}:#{@port}"
end

#set(key, value, expiry = nil) ⇒ Object 



231
232
233
234
235
 
# File 'lib/redis.rb', line 231

def set(key, value, expiry=nil)
  s = call_command([:set, key, value]) == OK
  expire(key, expiry) if s && expiry
  s
end

#sort(key, options = {}) ⇒ Object 



237
238
239
240
241
242
243
244
245
 
# File 'lib/redis.rb', line 237

def sort(key, options = {})
  cmd = ["SORT"]
  cmd << key
  cmd << "BY #{options[:by]}" if options[:by]
  cmd << "GET #{[options[:get]].flatten * ' GET '}" if options[:get]
  cmd << "#{options[:order]}" if options[:order]
  cmd << "LIMIT #{options[:limit].join(' ')}" if options[:limit]
  call_command(cmd)
end

#to_s ⇒ Object 



115
116
117
 
# File 'lib/redis.rb', line 115

def to_s
  "Redis Client connected to #{server} against DB #{@db}"
end

#type(key) ⇒ Object

Ruby defines a now deprecated type method so we need to override it here since it will never hit method_missing



271
272
273
 
# File 'lib/redis.rb', line 271

def type(key)
  call_command(['type', key])
end