Class: ActiveSupport::Cache::DalliStore

Inherits:
Object
  • Object
show all
Defined in:
lib/active_support/cache/dalli_store.rb

Constant Summary collapse

ESCAPE_KEY_CHARS = 
/[\x00-\x20%\x7F-\xFF]/

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*addresses) ⇒ DalliStore

Creates a new DalliStore object, with the given memcached server addresses. Each address is either a host name, or a host-with-port string in the form of “host_name:port”. For example:

ActiveSupport::Cache::DalliStore.new("localhost", "server-downstairs.localnetwork:8229")

If no addresses are specified, then DalliStore will connect to localhost port 11211 (the default memcached port).



37
38
39
40
41
42
43
44
45
 
# File 'lib/active_support/cache/dalli_store.rb', line 37

def initialize(*addresses)
  addresses = addresses.flatten
  options = addresses.extract_options!
  @options = options.dup
  @options[:compress] ||= @options[:compression]
  @raise_errors = !!@options[:raise_errors]
  addresses << 'localhost:11211' if addresses.empty?
  @data = Dalli::Client.new(addresses, @options)
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



9
10
11
 
# File 'lib/active_support/cache/dalli_store.rb', line 9

def options
  @options
end

#silence ⇒ Object (readonly) Also known as: silence?

Returns the value of attribute silence.



9
10
11
 
# File 'lib/active_support/cache/dalli_store.rb', line 9

def silence
  @silence
end

Instance Method Details

#clear(options = nil) ⇒ Object

Clear the entire cache on all memcached servers. This method should be used with care when using a shared cache.



165
166
167
 
# File 'lib/active_support/cache/dalli_store.rb', line 165

def clear(options=nil)
  @data.flush_all
end

#decrement(name, amount = 1, options = nil) ⇒ Object

Decrement a cached value. This method uses the memcached decr atomic operator and can only be used on values written with the :raw option. Calling it on a value not stored with :raw will fail. :initial defaults to zero, as if the counter was initially zero. memcached counters cannot hold negative values.



149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/active_support/cache/dalli_store.rb', line 149

def decrement(name, amount = 1, options=nil)
  options ||= {}
  name = expanded_key name
  initial = options.has_key?(:initial) ? options[:initial] : 0
  expires_in = options[:expires_in]
  instrument(:decrement, name, :amount => amount) do
    @data.decr(name, amount, expires_in, initial)
  end
rescue Dalli::DalliError => e
  logger.error("DalliError: #{e.message}") if logger
  raise if @raise_errors
  nil
end

#delete(name, options = nil) ⇒ Object 



101
102
103
104
105
106
 
# File 'lib/active_support/cache/dalli_store.rb', line 101

def delete(name, options=nil)
  options ||= {}
  name = expanded_key name

  delete_entry(name, options)
end

#exist?(name, options = nil) ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
97
98
99
 
# File 'lib/active_support/cache/dalli_store.rb', line 94

def exist?(name, options=nil)
  options ||= {}
  name = expanded_key name

  !read_entry(name, options).nil?
end

#fetch(name, options = nil) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/active_support/cache/dalli_store.rb', line 47

def fetch(name, options=nil)
  options ||= {}
  name = expanded_key name

  if block_given?
    unless options[:force]
      entry = instrument(:read, name, options) do |payload|
        payload[:super_operation] = :fetch if payload
        read_entry(name, options)
      end
    end

    if !entry.nil?
      instrument(:fetch_hit, name, options) { |payload| }
      entry
    else
      result = instrument(:generate, name, options) do |payload|
        yield
      end
      write(name, result, options)
      result
    end
  else
    read(name, options)
  end
end

#increment(name, amount = 1, options = nil) ⇒ Object

Increment a cached value. This method uses the memcached incr atomic operator and can only be used on values written with the :raw option. Calling it on a value not stored with :raw will fail. :initial defaults to the amount passed in, as if the counter was initially zero. memcached counters cannot hold negative values.



130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/active_support/cache/dalli_store.rb', line 130

def increment(name, amount = 1, options=nil)
  options ||= {}
  name = expanded_key name
  initial = options.has_key?(:initial) ? options[:initial] : amount
  expires_in = options[:expires_in]
  instrument(:increment, name, :amount => amount) do
    @data.incr(name, amount, expires_in, initial)
  end
rescue Dalli::DalliError => e
  logger.error("DalliError: #{e.message}") if logger
  raise if @raise_errors
  nil
end

#mute ⇒ Object

Silence the logger within a block.



19
20
21
22
23
24
 
# File 'lib/active_support/cache/dalli_store.rb', line 19

def mute
  previous_silence, @silence = defined?(@silence) && @silence, true
  yield
ensure
  @silence = previous_silence
end

#read(name, options = nil) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/active_support/cache/dalli_store.rb', line 74

def read(name, options=nil)
  options ||= {}
  name = expanded_key name

  instrument(:read, name, options) do |payload|
    entry = read_entry(name, options)
    payload[:hit] = !!entry if payload
    entry
  end
end

#read_multi(*names) ⇒ Object

Reads multiple keys from the cache using a single call to the servers for all keys. Keys must be Strings.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/active_support/cache/dalli_store.rb', line 110

def read_multi(*names)
  options = names.extract_options!
  names = names.flatten
  mapping = names.inject({}) { |memo, name| memo[escape(expanded_key(name))] = name; memo }
  instrument(:read_multi, names) do
    results = @data.get_multi(mapping.keys)
    results.inject({}) do |memo, (inner, value)|
      entry = results[inner]
      # NB Backwards data compatibility, to be removed at some point
      memo[mapping[inner]] = (entry.is_a?(ActiveSupport::Cache::Entry) ? entry.value : entry)
      memo
    end
  end
end

#reset ⇒ Object 



174
175
176
 
# File 'lib/active_support/cache/dalli_store.rb', line 174

def reset
  @data.reset
end

#silence! ⇒ Object

Silence the logger.



13
14
15
16
 
# File 'lib/active_support/cache/dalli_store.rb', line 13

def silence!
  @silence = true
  self
end

#stats ⇒ Object

Get the statistics from the memcached servers.



170
171
172
 
# File 'lib/active_support/cache/dalli_store.rb', line 170

def stats
  @data.stats
end

#write(name, value, options = nil) ⇒ Object 



85
86
87
88
89
90
91
92
 
# File 'lib/active_support/cache/dalli_store.rb', line 85

def write(name, value, options=nil)
  options ||= {}
  name = expanded_key name

  instrument(:write, name, options) do |payload|
    write_entry(name, value, options)
  end
end