W3cubDocs

module ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods

Constants

ID_ATTRIBUTE_METHODS

Public Instance Methods

dangerous_attribute_method?(method_name) Show source

# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 63
def dangerous_attribute_method?(method_name)
  super && !ID_ATTRIBUTE_METHODS.include?(method_name)
end

Calls superclass method

instance_method_already_implemented?(method_name) Show source

# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 59
def instance_method_already_implemented?(method_name)
  super || primary_key && ID_ATTRIBUTE_METHODS.include?(method_name)
end

Calls superclass method

primary_key() Show source

# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 70
def primary_key
  @primary_key = reset_primary_key unless defined? @primary_key
  @primary_key
end

Defines the primary key field – can be overridden in subclasses. Overwriting will negate any effect of the primary_key_prefix_type setting, though.

primary_key=(value) Show source

# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 119
def primary_key=(value)
  @primary_key        = value && -value.to_s
  @quoted_primary_key = nil
  @attributes_builder = nil
end

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"

quoted_primary_key() Show source

# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 77
def quoted_primary_key
  @quoted_primary_key ||= connection.quote_column_name(primary_key)
end

Returns a quoted version of the primary key name, used to construct SQL statements.