instance method cache_key

Ruby on Rails 5.0.7.2

Since v3.2.22.5

Available in: v3.2.22.5 v4.0.13 v4.1.16 v4.2.11.3 v5.0.7.2 v5.1.7 v5.2.8.1 v6.0.6.1 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3.2 v8.0.5.1 v8.1.3.1 edge

Signature

cache_key(*timestamp_names)

Returns a cache key that can be used to identify this record.

Product.new.cache_key     # => "products/new"
Product.find(5).cache_key # => "products/5" (updated_at not available)
Person.find(5).cache_key  # => "people/5-20071224150000" (updated_at available)

You can also pass a list of named timestamps, and the newest in the list will be used to generate the key:

Person.find(5).cache_key(:updated_at, :last_reviewed_at)

Parameters

timestamp_names rest
Source
# File activerecord/lib/active_record/integration.rb, line 55
    def cache_key(*timestamp_names)
      if new_record?
        "#{model_name.cache_key}/new"
      else
        timestamp = if timestamp_names.any?
          max_updated_column_timestamp(timestamp_names)
        else
          max_updated_column_timestamp
        end

        if timestamp
          timestamp = timestamp.utc.to_s(cache_timestamp_format)
          "#{model_name.cache_key}/#{id}-#{timestamp}"
        else
          "#{model_name.cache_key}/#{id}"
        end
      end
    end

Defined in activerecord/lib/active_record/integration.rb line 55 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::Integration

Type at least 2 characters to search.

Use the arrow keys to navigate results, Enter to open one, Escape to close.

Keyboard shortcuts

/
Focus search
⌘K / Ctrl-K
Command palette
?
This help
Esc
Close