Class: ActiveSupport::Cache::CouchbaseStore
- Inherits:
-
Store
- Object
- Store
- ActiveSupport::Cache::CouchbaseStore
- Defined in:
- lib/active_support/cache/couchbase_store.rb
Overview
This class implements Cache interface for Rails. To use it just put following line in your config/application.rb file:
config.cache_store = :couchbase_store
You can also pass additional connection options there
= {
:bucket => 'protected',
:username => 'protected',
:password => 'secret',
:expires_in => 30.seconds
}
config.cache_store = :couchbase_store,
Defined Under Namespace
Modules: Threadsafe
Instance Method Summary collapse
-
#decrement(name, amount = 1, options = nil) ⇒ Fixnum
Decrement an integer value in the cache.
-
#delete(name, options = nil) ⇒ true, false
Deletes an entry in the cache.
-
#delete_entry(key, options) ⇒ Object
protected
Delete an entry from the cache.
-
#exists?(name, options = nil) ⇒ true, false
(also: #exist?)
Return true if the cache contains an entry for the given key.
-
#fetch(name, options = nil) ⇒ Object
Fetches data from the cache, using the given key.
-
#increment(name, amount = 1, options = nil) ⇒ Fixnum
Increment an integer value in the cache.
-
#initialize(*args) ⇒ CouchbaseStore
constructor
Creates a new CouchbaseStore object, with the given options.
-
#read(name, options = nil) ⇒ Object
Fetches data from the cache, using the given key.
-
#read_entry(key, options) ⇒ Object
protected
Read an entry from the cache.
-
#read_multi(*names) ⇒ Hash
Read multiple values at once from the cache.
-
#stats(*arg) ⇒ Hash
Get the statistics from the memcached servers.
-
#write(name, value, options = nil) ⇒ Fixnum, false
Writes the value to the cache, with the key.
-
#write_entry(key, value, options) ⇒ Object
protected
Write an entry to the cache.
Constructor Details
#initialize(*args) ⇒ CouchbaseStore
Creates a new CouchbaseStore object, with the given options. For more info see ActiveSupport::Cache::CouchbaseStore.{Couchbase{Couchbase::Bucket{Couchbase::Bucket#initialize}
ActiveSupport::Cache::CouchbaseStore.new(:bucket => "cache")
If no options are specified, then CouchbaseStore will connect to localhost port 8091 (default Couchbase Server port) and will use bucket named “default” which is always open for unauthorized access (if exists).
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/couchbase_store.rb', line 51 def initialize(*args) args = [*(args.flatten)] = args. || {} @raise_errors = ![:quiet] = !.delete(:raise_errors) [:default_ttl] ||= .delete(:expires_in) [:default_format] ||= :marshal [:key_prefix] ||= .delete(:namespace) [:connection_pool] ||= .delete(:connection_pool) args.push() if [:connection_pool] if RUBY_VERSION.to_f < 1.9 warn "connection_pool gem doesn't support ruby < 1.9" else @data = ::Couchbase::ConnectionPool.new([:connection_pool], *args) end end unless @data @data = ::Couchbase::Bucket.new(*args) @data.extend(Threadsafe) end end |
Instance Method Details
#decrement(name, amount = 1, options = nil) ⇒ Fixnum
Decrement an integer value in the cache.
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/active_support/cache/couchbase_store.rb', line 281 def decrement(name, amount = 1, = nil) ||= {} name = name if ttl = .delete(:expires_in) [:ttl] ||= ttl end [:create] = true instrument(:decrement, name, ) do |payload| payload[:amount] = amount if payload @data.decr(name, amount, ) end rescue ::Couchbase::Error::Base => e logger.error("#{e.class}: #{e.}") if logger raise if @raise_errors false end |
#delete(name, options = nil) ⇒ true, false
Deletes an entry in the cache.
226 227 228 229 230 231 232 233 |
# File 'lib/active_support/cache/couchbase_store.rb', line 226 def delete(name, = nil) ||= {} name = name instrument(:delete, name) do delete_entry(name, ) end end |
#delete_entry(key, options) ⇒ Object (protected)
Delete an entry from the cache.
337 338 339 340 341 342 343 |
# File 'lib/active_support/cache/couchbase_store.rb', line 337 def delete_entry(key, ) # :nodoc: @data.delete(key, ) rescue ::Couchbase::Error::Base => e logger.error("#{e.class}: #{e.}") if logger raise if @raise_errors false end |
#exists?(name, options = nil) ⇒ true, false Also known as: exist?
Return true if the cache contains an entry for the given key.
211 212 213 214 215 216 217 218 |
# File 'lib/active_support/cache/couchbase_store.rb', line 211 def exists?(name, = nil) ||= {} name = name instrument(:exists?, name) do !read_entry(name, ).nil? end end |
#fetch(name, options = nil) ⇒ Object
Fetches data from the cache, using the given key.
If there is data in the cache with the given key, then that data is returned. If there is no such data in the cache (a cache miss), then nil will be returned. However, if a block has been passed, that block will be run in the event of a cache miss. The return value of the block will be written to the cache under the given cache key, and that return value will be returned.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/active_support/cache/couchbase_store.rb', line 97 def fetch(name, = nil) ||= {} name = (name) if block_given? unless [:force] entry = instrument(:read, name, ) do |payload| payload[:super_operation] = :fetch if payload read_entry(name, ) end end if !entry.nil? instrument(:fetch_hit, name, ) { |payload| } entry else result = instrument(:generate, name, ) do |payload| yield end write(name, result, ) result end else read(name, ) end end |
#increment(name, amount = 1, options = nil) ⇒ Fixnum
Increment an integer value in the cache.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/active_support/cache/couchbase_store.rb', line 249 def increment(name, amount = 1, = nil) ||= {} name = name if ttl = .delete(:expires_in) [:ttl] ||= ttl end [:create] = true instrument(:increment, name, ) do |payload| payload[:amount] = amount if payload @data.incr(name, amount, ) end rescue ::Couchbase::Error::Base => e logger.error("#{e.class}: #{e.}") if logger raise if @raise_errors false end |
#read(name, options = nil) ⇒ Object
Fetches data from the cache, using the given key.
If there is data in the cache with the given key, then that data is returned. Otherwise, nil is returned.
167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/active_support/cache/couchbase_store.rb', line 167 def read(name, = nil) ||= {} name = name if .delete(:raw) [:format] = :plain end instrument(:read, name, ) do |payload| entry = read_entry(name, ) payload[:hit] = !!entry if payload entry end end |
#read_entry(key, options) ⇒ Object (protected)
Read an entry from the cache.
311 312 313 314 315 316 317 |
# File 'lib/active_support/cache/couchbase_store.rb', line 311 def read_entry(key, ) # :nodoc: @data.get(key, ) rescue ::Couchbase::Error::Base => e logger.error("#{e.class}: #{e.}") if logger raise if @raise_errors nil end |
#read_multi(*names) ⇒ Hash
Read multiple values at once from the cache.
Options can be passed in the last argument.
Returns a hash mapping the names provided to the values found.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/active_support/cache/couchbase_store.rb', line 190 def read_multi(*names) = names. names = names.flatten.map{|name| (name)} [:assemble_hash] = true if .delete(:raw) [:format] = :plain end instrument(:read_multi, names, ) do @data.get(names, ) end rescue ::Couchbase::Error::Base => e logger.error("#{e.class}: #{e.}") if logger raise if @raise_errors false end |
#stats(*arg) ⇒ Hash
Get the statistics from the memcached servers.
304 305 306 |
# File 'lib/active_support/cache/couchbase_store.rb', line 304 def stats(*arg) @data.stats(*arg) end |
#write(name, value, options = nil) ⇒ Fixnum, false
Writes the value to the cache, with the key
137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/active_support/cache/couchbase_store.rb', line 137 def write(name, value, = nil) ||= {} name = name if .delete(:raw) [:format] = :plain value = value.to_s value.force_encoding(Encoding::BINARY) if defined?(Encoding) end instrument(:write, name, ) do |payload| write_entry(name, value, ) end end |
#write_entry(key, value, options) ⇒ Object (protected)
Write an entry to the cache.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/active_support/cache/couchbase_store.rb', line 320 def write_entry(key, value, ) # :nodoc: method = if [:unless_exists] || [:unless_exist] :add else :set end if ttl = .delete(:expires_in) [:ttl] ||= ttl end @data.send(method, key, value, ) rescue ::Couchbase::Error::Base => e logger.error("#{e.class}: #{e.}") if logger raise if @raise_errors false end |