Module: ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods

Defined in:
activerecord/lib/active_record/attribute_methods/primary_key.rb

Constant Summary collapse

ID_ATTRIBUTE_METHODS = 
%w(id id= id? id_before_type_cast id_was id_in_database id_for_database).to_set
PRIMARY_KEY_NOT_SET = 
BasicObject.new

Instance Method Summary collapse

Instance Method Details

#composite_primary_key? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


90
91
92
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 90

def composite_primary_key? # :nodoc:
  primary_key.is_a?(Array)
end

#dangerous_attribute_method?(method_name) ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 76

def dangerous_attribute_method?(method_name)
  super && !ID_ATTRIBUTE_METHODS.include?(method_name)
end

#get_primary_key(base_name) ⇒ Object

:nodoc:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 108

def get_primary_key(base_name) # :nodoc:
  if base_name && primary_key_prefix_type == :table_name
    base_name.foreign_key(false)
  elsif base_name && primary_key_prefix_type == :table_name_with_underscore
    base_name.foreign_key
  else
    if ActiveRecord::Base != self && table_exists?
      pk = connection.schema_cache.primary_keys(table_name)
      suppress_composite_primary_key(pk)
    else
      "id"
    end
  end
end

#instance_method_already_implemented?(method_name) ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 72

def instance_method_already_implemented?(method_name)
  super || primary_key && ID_ATTRIBUTE_METHODS.include?(method_name)
end

#primary_key ⇒ Object

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



83
84
85
86
87
88
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 83

def primary_key
  if PRIMARY_KEY_NOT_SET.equal?(@primary_key)
    @primary_key = reset_primary_key
  end
  @primary_key
end

#primary_key=(value) ⇒ Object

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"



138
139
140
141
142
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 138

def primary_key=(value)
  @primary_key        = derive_primary_key(value)
  @quoted_primary_key = nil
  @attributes_builder = nil
end

#quoted_primary_key ⇒ Object

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



96
97
98
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 96

def quoted_primary_key
  @quoted_primary_key ||= connection.quote_column_name(primary_key)
end

#reset_primary_key ⇒ Object

:nodoc:



100
101
102
103
104
105
106
 
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 100

def reset_primary_key # :nodoc:
  if base_class?
    self.primary_key = get_primary_key(base_class.name)
  else
    self.primary_key = base_class.primary_key
  end
end