Module: ActiveSupport::Cache
- Includes:
- ConnectionPoolLike
- Defined in:
- activesupport/lib/active_support/cache.rb,
activesupport/lib/active_support/cache/file_store.rb,
activesupport/lib/active_support/cache/null_store.rb,
activesupport/lib/active_support/cache/memory_store.rb,
activesupport/lib/active_support/cache/mem_cache_store.rb,
activesupport/lib/active_support/cache/redis_cache_store.rb,
activesupport/lib/active_support/cache/strategy/local_cache.rb,
activesupport/lib/active_support/cache/strategy/local_cache_middleware.rb
Overview
See ActiveSupport::Cache::Store for documentation.
Defined Under Namespace
Modules: ConnectionPoolLike, Strategy Classes: Entry, FileStore, MemCacheStore, MemoryStore, NullStore, RedisCacheStore, Store
Constant Summary collapse
- UNIVERSAL_OPTIONS =
These options mean something to all cache implementations. Individual cache implementations may support additional options.
[:namespace, :compress, :compress_threshold, :expires_in, :race_condition_ttl]
Class Method Summary collapse
-
.expand_cache_key(key, namespace = nil) ⇒ Object
Expands out the
key
argument into a key that can be used for the cache store. -
.lookup_store(*store_option) ⇒ Object
Creates a new Store object according to the given options.
Methods included from ConnectionPoolLike
Class Method Details
.expand_cache_key(key, namespace = nil) ⇒ Object
Expands out the key
argument into a key that can be used for the cache store. Optionally accepts a namespace, and all keys will be scoped within that namespace.
If the key
argument provided is an array, or responds to to_a
, then each of elements in the array will be turned into parameters/keys and concatenated into a single key. For example:
ActiveSupport::Cache.([:foo, :bar]) # => "foo/bar"
ActiveSupport::Cache.([:foo, :bar], "namespace") # => "namespace/foo/bar"
The key
argument can also respond to cache_key
or to_param
.
82 83 84 85 86 87 88 89 90 91 |
# File 'activesupport/lib/active_support/cache.rb', line 82 def (key, namespace = nil) = (namespace ? "#{namespace}/" : "").dup if prefix = ENV["RAILS_CACHE_ID"] || ENV["RAILS_APP_VERSION"] << "#{prefix}/" end << retrieve_cache_key(key) end |
.lookup_store(*store_option) ⇒ Object
Creates a new Store object according to the given options.
If no arguments are passed to this method, then a new ActiveSupport::Cache::MemoryStore object will be returned.
If you pass a Symbol as the first argument, then a corresponding cache store class under the ActiveSupport::Cache namespace will be created. For example:
ActiveSupport::Cache.lookup_store(:memory_store)
# => returns a new ActiveSupport::Cache::MemoryStore object
ActiveSupport::Cache.lookup_store(:mem_cache_store)
# => returns a new ActiveSupport::Cache::MemCacheStore object
Any additional arguments will be passed to the corresponding cache store class’s constructor:
ActiveSupport::Cache.lookup_store(:file_store, '/tmp/cache')
# => same as: ActiveSupport::Cache::FileStore.new('/tmp/cache')
If the first argument is not a Symbol, then it will simply be returned:
ActiveSupport::Cache.lookup_store(MyOwnCacheStore.new)
# => returns MyOwnCacheStore.new
56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'activesupport/lib/active_support/cache.rb', line 56 def lookup_store(*store_option) store, *parameters = *Array.wrap(store_option).flatten case store when Symbol = parameters. retrieve_store_class(store).new(*parameters, **) when nil ActiveSupport::Cache::MemoryStore.new else store end end |