method

write

Ruby on Rails latest stable (v7.1.3.2) - 0 notes - Class: ActiveSupport::Cache::Store

write(name, value, options = nil) public

Writes the value to the cache with the key. The value must be supported by the coder's dump and load methods.

By default, cache entries larger than 1kB are compressed. Compression allows more data to be stored in the same memory footprint, leading to fewer cache evictions and higher hit rates.

Options

compress: false - Disables compression of the cache entry.
:compress_threshold - The compression threshold, specified in bytes. Cache entries larger than this threshold will be compressed. Defaults to 1.kilobyte.

:expires_in - Sets a relative expiration time for the cache entry, specified in seconds. :expire_in and :expired_in are aliases for :expires_in.

cache = ActiveSupport::Cache::MemoryStore.new(expires_in: 5.minutes)
cache.write(key, value, expires_in: 1.minute) # Set a lower value for one entry

:expires_at - Sets an absolute expiration time for the cache entry.

cache = ActiveSupport::Cache::MemoryStore.new
cache.write(key, value, expires_at: Time.now.at_end_of_hour)

:version - Specifies a version for the cache entry. When reading from the cache, if the cached version does not match the requested version, the read will be treated as a cache miss. This feature is used to support recyclable cache keys.

Other options will be handled by the specific cache store implementation.

Show source

# File activesupport/lib/active_support/cache.rb, line 663
      def write(name, value, options = nil)
        options = merged_options(options)

        instrument(:write, name, options) do
          entry = Entry.new(value, **options.merge(version: normalize_version(name, options)))
          write_entry(normalize_key(name, options), entry, **options)
        end
      end

write

Related methods

Options