123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::ConnectionAdapters::ForeignKeyDefinition

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Struct
Instance Chain:
self, ::Struct
Inherits: Struct
  • ::Object
Defined in: activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb

Instance Attribute Summary

Instance Method Summary

::Struct - Inherited

#as_json

Instance Attribute Details

#custom_primary_key? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 149



def custom_primary_key?
  options[:primary_key] != default_primary_key
end


  








  

    #export_name_on_schema_dump?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 158



def export_name_on_schema_dump?
  !ActiveRecord::SchemaDumper.fk_ignore_pattern.match?(name) if name
end


  








  

    #from_table   (rw)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 124



ForeignKeyDefinition = Struct.new(:from_table, :to_table, :options)


  








  

    #options   (rw)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 124



ForeignKeyDefinition = Struct.new(:from_table, :to_table, :options)


  








  

    #to_table   (rw)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 124



ForeignKeyDefinition = Struct.new(:from_table, :to_table, :options)


  








  

    #validate?  ⇒ Boolean  (readonly)
    Also known as: #validated?
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 153



def validate?
  options.fetch(:validate, true)
end


  








  

    #validated?   (readonly)
  



  

    

Alias for #validate?.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 156



alias validated? validate?


  







Instance Method Details



  

    #column  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 129



def column
  options[:column]
end


  








  

    #default_primary_key   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 169



def default_primary_key
  "id"
end


  








  

    #deferrable  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 145



def deferrable
  options[:deferrable]
end


  








  

    #defined_for?(to_table: nil, validate: nil, **options)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 162



def defined_for?(to_table: nil, validate: nil, **options)
  (to_table.nil? || to_table.to_s == self.to_table) &&
    (validate.nil? || validate == self.options.fetch(:validate, validate)) &&
    options.all? { |k, v| Array(self.options[k]).map(&:to_s) == Array(v).map(&:to_s) }
end


  








  

    #name  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 125



def name
  options[:name]
end


  








  

    #on_delete  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 137



def on_delete
  options[:on_delete]
end


  








  

    #on_update  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 141



def on_update
  options[:on_update]
end


  








  

    #primary_key  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 133



def primary_key
  options[:primary_key] || default_primary_key
end