instance method attr_readonly

Ruby on Rails 7.0.10

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

attr_readonly(*attributes)

Attributes listed as readonly will be used to create a new record but update operations will ignore these fields.

You can assign a new value to a readonly attribute, but it will be ignored when the record is updated.

Examples

class Post < ActiveRecord::Base
  attr_readonly :title
end

post = Post.create!(title: "Introducing Ruby on Rails!")
post.update(title: "a different title") # change to title will be ignored

Parameters

attributes rest
Source
# File activerecord/lib/active_record/readonly_attributes.rb, line 25
      def attr_readonly(*attributes)
        self._attr_readonly = Set.new(attributes.map(&:to_s)) + (_attr_readonly || [])
      end

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

Defined in ActiveRecord::ReadonlyAttributes::ClassMethods

Type at least 2 characters to search.

↑↓ navigate · open · esc close