Parent

ActiveSupport::Cache::RedisStore

Public Class Methods

new(*addresses) click to toggle source

Instantiate the store.

Example:

RedisStore.new
  # => host: localhost,   port: 6379,  db: 0

RedisStore.new "example.com"
  # => host: example.com, port: 6379,  db: 0

RedisStore.new "example.com:23682"
  # => host: example.com, port: 23682, db: 0

RedisStore.new "example.com:23682/1"
  # => host: example.com, port: 23682, db: 1

RedisStore.new "example.com:23682/1/theplaylist"
  # => host: example.com, port: 23682, db: 1, namespace: theplaylist

RedisStore.new "localhost:6379/0", "localhost:6380/0"
  # => instantiate a cluster
# File lib/active_support/cache/redis_store.rb, line 26
def initialize(*addresses)
  @data = ::Redis::Store::Factory.create(addresses)
  super(addresses.extract_options!)
end

Public Instance Methods

clear() click to toggle source

Clear all the data from the store.

# File lib/active_support/cache/redis_store.rb, line 137
def clear
  instrument(:clear, nil, nil) do
    @data.flushdb
  end
end
decrement(key, amount = 1) click to toggle source

Decrement a key in the store

If the key doesn’t exist it will be initialized on 0. If the key exist but it isn’t a Fixnum it will be initialized on 0.

Example:

We have two objects in cache:
  counter # => 23
  rabbit  # => #<Rabbit:0x5eee6c>

cache.decrement "counter"
cache.read "counter", :raw => true      # => "22"

cache.decrement "counter", 2
cache.read "counter", :raw => true      # => "20"

cache.decrement "a counter"
cache.read "a counter", :raw => true    # => "-1"

cache.decrement "rabbit"
cache.read "rabbit", :raw => true       # => "-1"
# File lib/active_support/cache/redis_store.rb, line 126
def decrement(key, amount = 1)
  instrument(:decrement, key, :amount => amount) do
    @data.decrby key, amount
  end
end
delete_matched(matcher, options = nil) click to toggle source

Delete objects for matched keys.

Performance note: this operation can be dangerous for large production databases, as it uses the Redis “KEYS” command, which is O(N) over the total number of keys in the database. Users of large Redis caches should avoid this method.

Example:

cache.del_matched "rab*"
# File lib/active_support/cache/redis_store.rb, line 48
def delete_matched(matcher, options = nil)
  options = merged_options(options)
  instrument(:delete_matched, matcher.inspect) do
    matcher = key_matcher(matcher, options)
    begin
      !(keys = @data.keys(matcher)).empty? && @data.del(*keys)
    rescue Errno::ECONNREFUSED => e
      false
    end
  end
end
exist?(name, options = nil) click to toggle source

fixed problem with invalid exists? method github.com/rails/rails/commit/cad2c8f5791d5bd4af0f240d96e00bae76eabd2f

# File lib/active_support/cache/redis_store.rb, line 145
def exist?(name, options = nil)
  res = super(name, options)
  res || false
end
expire(key, ttl) click to toggle source
# File lib/active_support/cache/redis_store.rb, line 132
def expire(key, ttl)
  @data.expire key, ttl
end
increment(key, amount = 1) click to toggle source

Increment a key in the store.

If the key doesn’t exist it will be initialized on 0. If the key exist but it isn’t a Fixnum it will be initialized on 0.

Example:

We have two objects in cache:
  counter # => 23
  rabbit  # => #<Rabbit:0x5eee6c>

cache.increment "counter"
cache.read "counter", :raw => true      # => "24"

cache.increment "counter", 6
cache.read "counter", :raw => true      # => "30"

cache.increment "a counter"
cache.read "a counter", :raw => true    # => "1"

cache.increment "rabbit"
cache.read "rabbit", :raw => true       # => "1"
# File lib/active_support/cache/redis_store.rb, line 99
def increment(key, amount = 1)
  instrument(:increment, key, :amount => amount) do
    @data.incrby key, amount
  end
end
read_multi(*names) click to toggle source

Reads multiple keys from the cache using a single call to the servers for all keys. Options can be passed in the last argument.

Example:

cache.read_multi "rabbit", "white-rabbit"
cache.read_multi "rabbit", "white-rabbit", :raw => true
# File lib/active_support/cache/redis_store.rb, line 66
def read_multi(*names)
  values = @data.mget(*names)
  values.map! { |v| v.is_a?(ActiveSupport::Cache::Entry) ? v.value : v }

  # Remove the options hash before mapping keys to values
  names.extract_options!

  result = Hash[names.zip(values)]
  result.reject!{ |k,v| v.nil? }
  result
end
reconnect() click to toggle source

Force client reconnection, useful Unicorn deployed apps.

# File lib/active_support/cache/redis_store.rb, line 155
def reconnect
  @data.reconnect
end
stats() click to toggle source
# File lib/active_support/cache/redis_store.rb, line 150
def stats
  @data.info
end
write(name, value, options = nil) click to toggle source
# File lib/active_support/cache/redis_store.rb, line 31
def write(name, value, options = nil)
  options = merged_options(options)
  instrument(:write, name, options) do |payload|
    entry = options[:raw].present? ? value : Entry.new(value, options)
    write_entry(namespaced_key(name, options), entry, options)
  end
end

Protected Instance Methods

delete_entry(key, options) click to toggle source

Implement the ActiveSupport::Cache#delete_entry

It’s really needed and use

# File lib/active_support/cache/redis_store.rb, line 181
def delete_entry(key, options)
  @data.del key
rescue Errno::ECONNREFUSED => e
  false
end
key_matcher(pattern, options) click to toggle source

Add the namespace defined in the options to a pattern designed to match keys.

This implementation is __different__ than ActiveSupport: __it doesn’t accept Regular expressions__, because the Redis matcher is designed only for strings with wildcards.

# File lib/active_support/cache/redis_store.rb, line 193
def key_matcher(pattern, options)
  prefix = options[:namespace].is_a?(Proc) ? options[:namespace].call : options[:namespace]
  if prefix
    raise "Regexps aren't supported, please use string with wildcards." if pattern.is_a?(Regexp)
    "#{prefix}:#{pattern}"
  else
    pattern
  end
end
read_entry(key, options) click to toggle source
# File lib/active_support/cache/redis_store.rb, line 167
def read_entry(key, options)
  entry = @data.get key, options
  if entry
    entry.is_a?(ActiveSupport::Cache::Entry) ? entry : ActiveSupport::Cache::Entry.new(entry)
  end
rescue Errno::ECONNREFUSED => e
  nil
end
write_entry(key, entry, options) click to toggle source
# File lib/active_support/cache/redis_store.rb, line 160
def write_entry(key, entry, options)
  method = options && options[:unless_exist] ? :setnx : :set
  @data.send method, key, entry, options
rescue Errno::ECONNREFUSED => e
  false
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.