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

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

Instance Method Summary collapse

Instance Method Details

#dangerous_attribute_method?(method_name) ⇒ Boolean


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

def dangerous_attribute_method?(method_name)
  super && !['id', 'id=', 'id?'].include?(method_name)
end

#define_method_attribute(attr_name) ⇒ Object


28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 28

def define_method_attribute(attr_name)
  super

  if attr_name == primary_key && attr_name != 'id'
    generated_attribute_methods.send(:alias_method, :id, primary_key)
    generated_external_attribute_methods.module_eval <<-CODE, __FILE__, __LINE__
      def id(v, attributes, attributes_cache, attr_name)
        attr_name = '#{primary_key}'
        send(attr_name, attributes[attr_name], attributes, attributes_cache, attr_name)
      end
    CODE
  end
end

#get_primary_key(base_name) ⇒ Object

:nodoc:


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 66

def get_primary_key(base_name) #:nodoc:
  return 'id' unless base_name && !base_name.blank?

  case primary_key_prefix_type
  when :table_name
    base_name.foreign_key(false)
  when :table_name_with_underscore
    base_name.foreign_key
  else
    if ActiveRecord::Base != self && table_exists?
      connection.schema_cache.primary_keys[table_name]
    else
      'id'
    end
  end
end

#original_primary_keyObject

:nodoc:


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

def original_primary_key #:nodoc:
  deprecated_original_property_getter :primary_key
end

#primary_keyObject

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


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

def primary_key
  @primary_key = reset_primary_key unless defined? @primary_key
  @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"

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

def primary_key=(value)
  @original_primary_key = @primary_key if defined?(@primary_key)
  @primary_key          = value && value.to_s
  @quoted_primary_key   = nil
end

#quoted_primary_keyObject

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


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

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

#reset_primary_keyObject

:nodoc:


58
59
60
61
62
63
64
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 58

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

#set_primary_key(value = nil, &block) ⇒ Object

:nodoc:


107
108
109
110
# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 107

def set_primary_key(value = nil, &block) #:nodoc:
  deprecated_property_setter :primary_key, value, block
  @quoted_primary_key = nil
end