Module: ActiveRecord::AttributeMethods::PrimaryKey

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

Overview

Active Record Attribute Methods Primary Key

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#id ⇒ Object

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



20
21
22
 
# File 'lib/active_record/attribute_methods/primary_key.rb', line 20

def id
  _read_attribute(@primary_key)
end

#id=(value) ⇒ Object

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



30
31
32
 
# File 'lib/active_record/attribute_methods/primary_key.rb', line 30

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

#id? ⇒ Boolean

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

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/active_record/attribute_methods/primary_key.rb', line 36

def id?
  _query_attribute(@primary_key)
end

#id_before_type_cast ⇒ Object

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.



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

def id_before_type_cast
  attribute_before_type_cast(@primary_key)
end

#id_for_database ⇒ Object

:nodoc:



58
59
60
 
# File 'lib/active_record/attribute_methods/primary_key.rb', line 58

def id_for_database # :nodoc:
  @attributes[@primary_key].value_for_database
end

#id_in_database ⇒ Object

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.



54
55
56
 
# File 'lib/active_record/attribute_methods/primary_key.rb', line 54

def id_in_database
  attribute_in_database(@primary_key)
end

#id_was ⇒ Object

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



48
49
50
 
# File 'lib/active_record/attribute_methods/primary_key.rb', line 48

def id_was
  attribute_was(@primary_key)
end

#primary_key_values_present? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

def primary_key_values_present? # :nodoc:
  !!id
end

#to_key ⇒ Object

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



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

def to_key
  key = id
  Array(key) if key
end