Module: ActiveRecord::AttributeMethods::PrimaryKey

Extended by:
ActiveSupport::Concern
Defined in:
activerecord/lib/active_record/attribute_methods/primary_key.rb

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included

Instance Method Details

#id ⇒ Object

Returns the primary key column’s value.



18
19
20
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 18

def id
  _read_attribute(@primary_key)
end

#id=(value) ⇒ Object

Sets the primary key column’s value.



23
24
25
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 23

def id=(value)
  _write_attribute(@primary_key, value)
end

#id? ⇒ Boolean

Queries the primary key column’s value.

Returns:

  • (Boolean) 


28
29
30
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 28

def id?
  query_attribute(@primary_key)
end

#id_before_type_cast ⇒ Object

Returns the primary key column’s value before type cast.



33
34
35
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 33

def id_before_type_cast
  read_attribute_before_type_cast(@primary_key)
end

#id_in_database ⇒ Object

Returns the primary key column’s value from the database.



43
44
45
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 43

def id_in_database
  attribute_in_database(@primary_key)
end

#id_was ⇒ Object

Returns the primary key column’s previous value.



38
39
40
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 38

def id_was
  attribute_was(@primary_key)
end

#to_key ⇒ Object

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



12
13
14
15
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 12

def to_key
  key = id
  [key] if key
end