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


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/active_support/cache/dalli_store.rb', line 36

def initialize(*addresses)
  addresses = addresses.flatten
  options = addresses.extract_options!
  @options = options.dup
  @options[:compress] ||= @options[:compression]
  @raise_errors = !!@options[:raise_errors]
  servers = if addresses.empty?
              nil # use the default from Dalli::Client
            else
              addresses
            end
  @data = Dalli::Client.new(servers, @options)

  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


205
206
# File 'lib/active_support/cache/dalli_store.rb', line 205

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.


194
195
196
197
198
199
200
201
202
# File 'lib/active_support/cache/dalli_store.rb', line 194

def clear(options=nil)
  instrument(:clear, 'flushing all keys') do
    @data.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 instance for access to get_multi, etc.


55
56
57
# File 'lib/active_support/cache/dalli_store.rb', line 55

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.


178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/active_support/cache/dalli_store.rb', line 178

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


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

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

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

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

Returns:

  • (Boolean)

110
111
112
113
114
115
116
# File 'lib/active_support/cache/dalli_store.rb', line 110

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

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

#fetch(name, options = nil) ⇒ Object


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/active_support/cache/dalli_store.rb', line 59

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

  if block_given?
    unless options[:force]
      entry = instrument(:read, name, options) do |payload|
        read_entry(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

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


159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/active_support/cache/dalli_store.rb', line 159

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

#loggerObject


217
218
219
# File 'lib/active_support/cache/dalli_store.rb', line 217

def logger
  Dalli.logger
end

#logger=(new_logger) ⇒ Object


221
222
223
# File 'lib/active_support/cache/dalli_store.rb', line 221

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


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

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.


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

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

    results.merge!(@data.get_multi(mapping.keys - results.keys))
    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


213
214
215
# File 'lib/active_support/cache/dalli_store.rb', line 213

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


209
210
211
# File 'lib/active_support/cache/dalli_store.rb', line 209

def stats
  @data.stats
end

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


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

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

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