Class: ActiveSupport::Cache::DalliStore

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

Defined Under Namespace

Modules: LocalCacheEntryUnwrapAndRaw

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method 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.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/active_support/cache/dalli_store.rb', line 52

def initialize(*addresses)
  puts <<-EOS
DEPRECATION: :dalli_store will be removed in Dalli 3.0.
Please use Rails' official :mem_cache_store instead.
https://guides.rubyonrails.org/caching_with_rails.html
EOS
  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
  extend LocalCacheEntryUnwrapAndRaw
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

Class Method Details

.supports_cache_versioning? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.supports_cache_versioning?
  true
end

Instance Method Details

#cleanup(options = nil) ⇒ Object

Clear any local cache



287
288
 
# File 'lib/active_support/cache/dalli_store.rb', line 287

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.



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/active_support/cache/dalli_store.rb', line 275

def clear(options=nil)
  instrument_with_log(:clear, 'flushing all keys') do
    with { |c| c.flush_all }
  end
rescue Dalli::DalliError => e
  log_dalli_error(e)
  instrument_error(e) if instrument_errors?
  raise if raise_errors?
  nil
end

#dalli ⇒ Object

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



87
88
89
 
# File 'lib/active_support/cache/dalli_store.rb', line 87

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.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/active_support/cache/dalli_store.rb', line 258

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_with_log(:decrement, name, :amount => amount) do
    with { |c| c.decr(name, amount, expires_in, initial) }
  end
rescue Dalli::DalliError => e
  log_dalli_error(e)
  instrument_error(e) if instrument_errors?
  raise if raise_errors?
  nil
end

#delete(name, options = nil) ⇒ Object 



167
168
169
170
171
172
173
174
 
# File 'lib/active_support/cache/dalli_store.rb', line 167

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

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

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

Returns:

  • (Boolean) 


159
160
161
162
163
164
165
 
# File 'lib/active_support/cache/dalli_store.rb', line 159

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

Fetch the value associated with the key. If a value is found, then it is returned.

If a value is not found and no block is given, then nil is returned.

If a value is not found (or if the found value is nil and :cache_nils is false) and a block is given, the block will be invoked and its return value written to the cache and returned.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/active_support/cache/dalli_store.rb', line 103

def fetch(name, options=nil)
  options ||= {}
  options[:cache_nils] = true if @options[:cache_nils]
  namespaced_name = namespaced_key(name, options)
  not_found = options[:cache_nils] ? Dalli::Server::NOT_FOUND : nil
  if block_given?
    entry = not_found
    unless options[:force]
      entry = instrument_with_log(:read, namespaced_name, options) do |payload|
        read_entry(namespaced_name, options).tap do |result|
          if payload
            payload[:super_operation] = :fetch
            payload[:hit] = not_found != result
          end
        end
      end
    end

    if not_found == entry
      result = instrument_with_log(:generate, namespaced_name, options) do |payload|
        yield(name)
      end
      write(name, result, options)
      result
    else
      instrument_with_log(:fetch_hit, namespaced_name, options) { |payload| }
      entry
    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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/active_support/cache/dalli_store.rb', line 208

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

  instrument_with_log(:fetch_multi, mapping.keys) 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.



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

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_with_log(:increment, name, :amount => amount) do
    with { |c| c.incr(name, amount, expires_in, initial) }
  end
rescue Dalli::DalliError => e
  log_dalli_error(e)
  instrument_error(e) if instrument_errors?
  raise if raise_errors?
  nil
end

#logger ⇒ Object 



299
300
301
 
# File 'lib/active_support/cache/dalli_store.rb', line 299

def logger
  Dalli.logger
end

#logger=(new_logger) ⇒ Object 



303
304
305
 
# File 'lib/active_support/cache/dalli_store.rb', line 303

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

#mute ⇒ Object

Silence the logger within a block.



23
24
25
26
27
28
 
# File 'lib/active_support/cache/dalli_store.rb', line 23

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

#read(name, options = nil) ⇒ Object 



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

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

  instrument_with_log(:read, name, options) do |payload|
    entry = read_entry(name, options)
    payload[:hit] = !entry.nil? 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.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/active_support/cache/dalli_store.rb', line 178

def read_multi(*names)
  options  = names.extract_options!
  mapping = names.inject({}) { |memo, name| memo[namespaced_key(name, options)] = name; memo }
  instrument_with_log(:read_multi, mapping.keys) 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

#reset ⇒ Object 



295
296
297
 
# File 'lib/active_support/cache/dalli_store.rb', line 295

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

#silence! ⇒ Object

Silence the logger.



17
18
19
20
 
# File 'lib/active_support/cache/dalli_store.rb', line 17

def silence!
  @silence = true
  self
end

#stats ⇒ Object

Get the statistics from the memcached servers.



291
292
293
 
# File 'lib/active_support/cache/dalli_store.rb', line 291

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

#with(&block) ⇒ Object 



91
92
93
 
# File 'lib/active_support/cache/dalli_store.rb', line 91

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

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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/active_support/cache/dalli_store.rb', line 147

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

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