123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Defined in: activerecord/lib/active_record/attribute_methods/primary_key.rb

Constant Summary

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#composite_primary_key? ⇒ Boolean (readonly)

This method is for internal use only.
[ GitHub ] 

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 87



def composite_primary_key? # :nodoc:
  reset_primary_key if PRIMARY_KEY_NOT_SET.equal?(@primary_key)
  @composite_primary_key
end


  








  

    #primary_key   (rw)
  



  

    

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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 82



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


  








  

    #primary_key=(value)   (rw)
  



  

    

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"


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 133



def primary_key=(value)
  @primary_key = if value.is_a?(Array)
    @composite_primary_key = true
    include CompositePrimaryKey
    @primary_key = value.map { |v| -v.to_s }.freeze
  elsif value
    -value.to_s
  end
  @quoted_primary_key = nil
  @attributes_builder = nil
end


  







Instance Method Details



  

    #dangerous_attribute_method?(method_name)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 75



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


  








  

    #get_primary_key(base_name)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 106



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
  elsif ActiveRecord::Base != self && table_exists?
    schema_cache.primary_keys(table_name)
  else
    "id"
  end
end


  








  

    #inherited(base)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 146



def inherited(base)
  super
  base.class_eval do
    @primary_key = PRIMARY_KEY_NOT_SET
    @composite_primary_key = false
    @quoted_primary_key = nil
    @attributes_builder = nil
  end
end


  








  

    #instance_method_already_implemented?(method_name)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 71



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


  








  

    #quoted_primary_key  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/primary_key.rb', line 94



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


  








  

    #reset_primary_key  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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