File Cache Store
A cache store implementation which stores everything on the filesystem.
Methods
Constants
DIR_FORMATTER | = | "%03X" |
FILENAME_MAX_SIZE | = | 226 |
FILEPATH_MAX_SIZE | = | 900 |
GITKEEP_FILES | = | [".gitkeep", ".keep"].freeze |
Attributes
[R] | cache_path |
Class Public methods
new(cache_path, **options) Link
supports_cache_versioning?() Link
Advertise cache versioning support.
Instance Public methods
cleanup(options = nil) Link
Preemptively iterates through all stored keys and removes the ones which have expired.
clear(options = nil) Link
Deletes all items from the cache. In this case it deletes all the entries in the specified file store directory except for .keep or .gitkeep. Be careful which directory is specified in your config file when using FileStore
because everything in that directory will be deleted.
decrement(name, amount = 1, options = nil) Link
Decrement a cached integer value. Returns the updated value.
If the key is unset, it will be set to -amount
.
cache.decrement("foo") # => -1
To set a specific value, call write
:
cache.write("baz", 5)
cache.decrement("baz") # => 4
# File activesupport/lib/active_support/cache/file_store.rb, line 80 def decrement(name, amount = 1, options = nil) options = merged_options(options) key = normalize_key(name, options) instrument(:decrement, key, amount: amount) do modify_value(name, -amount, options) end end
delete_matched(matcher, options = nil) Link
# File activesupport/lib/active_support/cache/file_store.rb, line 89 def delete_matched(matcher, options = nil) options = merged_options(options) matcher = key_matcher(matcher, options) instrument(:delete_matched, matcher.inspect) do search_dir(cache_path) do |path| key = file_path_key(path) delete_entry(path, **options) if key.match(matcher) end end end
increment(name, amount = 1, options = nil) Link
Increment a cached integer value. Returns the updated value.
If the key is unset, it starts from 0
:
cache.increment("foo") # => 1
cache.increment("bar", 100) # => 100
To set a specific value, call write
:
cache.write("baz", 5)
cache.increment("baz") # => 6
# File activesupport/lib/active_support/cache/file_store.rb, line 60 def increment(name, amount = 1, options = nil) options = merged_options(options) key = normalize_key(name, options) instrument(:increment, key, amount: amount) do modify_value(name, amount, options) end end