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).

Connection Pool support

If you are using multithreaded Rails, the Rails.cache singleton can become a source of contention. You can use a connection pool of Dalli clients with Rails.cache by passing :pool_size and/or :pool_timeout:

config.cache_store = :dalli_store, 'localhost:11211', :pool_size => 10

Both pool options default to 5. You must include the `connection_pool` gem if you wish to use pool support.



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
# File 'lib/active_support/cache/dalli_store.rb', line 47

def initialize(*addresses)
  addresses = addresses.flatten
  options = addresses.extract_options!
  @options = options.dup

  pool_options = {}
  pool_options[:size] = options[:pool_size] if options[:pool_size]
  pool_options[:timeout] = options[:pool_timeout] if options[:pool_timeout]

  @options[:compress] ||= @options[:compression]

  addresses.compact!
  servers = if addresses.empty?
              nil # use the default from Dalli::Client
            else
              addresses
            end
  if pool_options.empty?
    @data = Dalli::Client.new(servers, @options)
  else
    @data = ::ConnectionPool.new(pool_options) { Dalli::Client.new(servers, @options.merge(:threadsafe => false)) }
  end

  extend Strategy::LocalCache
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options



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

def options
  @options
end

#silenceObject (readonly) Also known as: silence?

Returns the value of attribute silence



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

def silence
  @silence
end

Instance Method Details

#cleanup(options = nil) ⇒ Object

Clear any local cache



263
264
# File 'lib/active_support/cache/dalli_store.rb', line 263

def cleanup(options=nil)
end

#clear(options = nil) ⇒ Object

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



252
253
254
255
256
257
258
259
260
# File 'lib/active_support/cache/dalli_store.rb', line 252

def clear(options=nil)
  instrument(:clear, 'flushing all keys') do
    with { |c| c.flush_all }
  end
rescue Dalli::DalliError => e
  logger.error("DalliError: #{e.message}") if logger
  raise if raise_errors?
  nil
end

#dalliObject

Access the underlying Dalli::Client or ConnectionPool instance for access to get_multi, etc.



76
77
78
# File 'lib/active_support/cache/dalli_store.rb', line 76

def dalli
  @data
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.



236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/active_support/cache/dalli_store.rb', line 236

def decrement(name, amount = 1, options=nil)
  options ||= {}
  name = namespaced_key(name, options)
  initial = options.has_key?(:initial) ? options[:initial] : 0
  expires_in = options[:expires_in]
  instrument(:decrement, name, :amount => amount) do
    with { |c| c.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



146
147
148
149
150
151
152
153
# File 'lib/active_support/cache/dalli_store.rb', line 146

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

  instrument(:delete, name, options) do |payload|
    delete_entry(name, options)
  end
end

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

Returns:

  • (Boolean)


138
139
140
141
142
143
144
# File 'lib/active_support/cache/dalli_store.rb', line 138

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

  log(:exist, name, options)
  !read_entry(name, options).nil?
end

#fetch(name, options = nil) ⇒ Object



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/active_support/cache/dalli_store.rb', line 84

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

  if block_given?
    unless options[:force]
      entry = instrument(:read, namespaced_name, options) do |payload|
        read_entry(namespaced_name, options).tap do |result|
          if payload
            payload[:super_operation] = :fetch
            payload[:hit] = !!result
          end
        end
      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

#fetch_multi(*names) ⇒ Object

Fetches data from the cache, using the given keys. If there is data in the cache with the given keys, then that data is returned. Otherwise, the supplied block is called for each key for which there was no data, and the result will be written to the cache and returned.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/active_support/cache/dalli_store.rb', line 187

def fetch_multi(*names)
  options = names.extract_options!
  mapping = names.inject({}) { |memo, name| memo[namespaced_key(name, options)] = name; memo }

  instrument(:fetch_multi, names) do
    with do |connection|
      results = connection.get_multi(mapping.keys)

      connection.multi do
        mapping.inject({}) do |memo, (expanded, name)|
          memo[name] = results[expanded]
          if memo[name].nil?
            value = yield(name)
            memo[name] = value
            options = options.merge(:connection => connection)
            write_entry(expanded, value, options)
          end

          memo
        end
      end
    end
  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.



217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/active_support/cache/dalli_store.rb', line 217

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

#loggerObject



275
276
277
# File 'lib/active_support/cache/dalli_store.rb', line 275

def logger
  Dalli.logger
end

#logger=(new_logger) ⇒ Object



279
280
281
# File 'lib/active_support/cache/dalli_store.rb', line 279

def logger=(new_logger)
  Dalli.logger = new_logger
end

#muteObject

Silence the logger within a block.



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

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

#read(name, options = nil) ⇒ Object



115
116
117
118
119
120
121
122
123
124
# File 'lib/active_support/cache/dalli_store.rb', line 115

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

  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.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/active_support/cache/dalli_store.rb', line 157

def read_multi(*names)
  options  = names.extract_options!
  mapping = names.inject({}) { |memo, name| memo[namespaced_key(name, options)] = name; memo }
  instrument(:read_multi, names) do
    results = {}
    if local_cache
      mapping.each_key do |key|
        if value = local_cache.read_entry(key, options)
          results[key] = value
        end
      end
    end

    data = with { |c| c.get_multi(mapping.keys - results.keys) }
    results.merge!(data)
    results.inject({}) do |memo, (inner, _)|
      entry = results[inner]
      # NB Backwards data compatibility, to be removed at some point
      value = (entry.is_a?(ActiveSupport::Cache::Entry) ? entry.value : entry)
      memo[mapping[inner]] = value
      local_cache.write_entry(inner, value, options) if local_cache
      memo
    end
  end
end

#resetObject



271
272
273
# File 'lib/active_support/cache/dalli_store.rb', line 271

def reset
  with { |c| c.reset }
end

#silence!Object

Silence the logger.



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

def silence!
  @silence = true
  self
end

#statsObject

Get the statistics from the memcached servers.



267
268
269
# File 'lib/active_support/cache/dalli_store.rb', line 267

def stats
  with { |c| c.stats }
end

#with(&block) ⇒ Object



80
81
82
# File 'lib/active_support/cache/dalli_store.rb', line 80

def with(&block)
  @data.with(&block)
end

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



126
127
128
129
130
131
132
133
134
135
136
# File 'lib/active_support/cache/dalli_store.rb', line 126

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

  instrument(:write, name, options) do |payload|
    with do |connection|
      options = options.merge(:connection => connection)
      write_entry(name, value, options)
    end
  end
end