instance method `primary_key=`

Ruby on Rails 7.2.3

Since v3.0.20

Available in: v3.0.20 v3.1.12 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

Compare with:

primary_key=(value)

Sets the name of the primary key column.

class Project < ActiveRecord::Base
  self.primary_key = 'sysid'
end

You can also define the #primary_key method yourself:

class Project < ActiveRecord::Base
  def self.primary_key
    'foo_' + super
  end
end

Project.primary_key # => "foo_id"

Parameters

value req

Source

# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 133
          def primary_key=(value)
            @primary_key = if value.is_a?(Array)
              @composite_primary_key = true
              include CompositePrimaryKey
              @primary_key = value.map { |v| -v.to_s }.freeze
            elsif value
              -value.to_s
            end
            @quoted_primary_key = nil
            @attributes_builder = nil
          end

Defined in activerecord/lib/active_record/attribute_methods/primary_key.rb line 133 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods

Signature

Parameters