instance method cache_key

Ruby on Rails 4.1.16

Since v3.2.22.5

Available in: v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

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)
      case
      when new_record?
        "#{self.class.model_name.cache_key}/new"
      when timestamp_names.any?
        timestamp = max_updated_column_timestamp(timestamp_names)
        timestamp = timestamp.utc.to_s(cache_timestamp_format)
        "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
      when timestamp = max_updated_column_timestamp
        timestamp = timestamp.utc.to_s(cache_timestamp_format)
        "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
      else
        "#{self.class.model_name.cache_key}/#{id}"
      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.

↑↓ navigate · open · esc close