Skip to Content Skip to Search

module ActiveRecord::AttributeMethods::PrimaryKey

Active Record Attribute Methods Primary Key

Public instance methods

id()

Returns the primary key column’s value. If the primary key is composite, returns an array of the primary key column values.

Source code GitHub 
# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 18
def id
  _read_attribute(@primary_key)
end

id=(value)

Sets the primary key column’s value. If the primary key is composite, raises TypeError when the set value not enumerable.

Source code GitHub 
# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 28
def id=(value)
  _write_attribute(@primary_key, value)
end

id?()

Queries the primary key column’s value. If the primary key is composite, all primary key column values must be queryable.

Source code GitHub 
# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 34
def id?
  _query_attribute(@primary_key)
end

id_before_type_cast()

Returns the primary key column’s value before type cast. If the primary key is composite, returns an array of primary key column values before type cast.

Source code GitHub 
# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 40
def id_before_type_cast
  attribute_before_type_cast(@primary_key)
end

id_in_database()

Returns the primary key column’s value from the database. If the primary key is composite, returns an array of primary key column values from database.

Source code GitHub 
# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 52
def id_in_database
  attribute_in_database(@primary_key)
end

id_was()

Returns the primary key column’s previous value. If the primary key is composite, returns an array of primary key column previous values.

Source code GitHub 
# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 46
def id_was
  attribute_was(@primary_key)
end

to_key()

Returns this record’s primary key value wrapped in an array if one is available.

Source code GitHub 
# File activerecord/lib/active_record/attribute_methods/primary_key.rb, line 11
def to_key
  key = id
  Array(key) if key
end

Namespace

Definition files