Module: Foreigner::ConnectionAdapters::Table::InstanceMethods

Defined in:
lib/foreigner/connection_adapters/abstract/schema_definitions.rb

Instance Method Summary collapse

Instance Method Details

#foreign_key(to_table, options = {}) ⇒ Object

Adds a new foreign key to the table. to_table can be a single Symbol, or an Array of Symbols. See SchemaStatements#add_foreign_key

Examples
Creating a simple foreign key
t.foreign_key(:people)
Defining the column
t.foreign_key(:people, :column => :sender_id)
Creating a named foreign key
t.foreign_key(:people, :column => :sender_id, :name => 'sender_foreign_key')
Defining the column of the to_table.
t.foreign_key(:people, :column => :sender_id, :primary_key => :person_id)



69
70
71
 
# File 'lib/foreigner/connection_adapters/abstract/schema_definitions.rb', line 69

def foreign_key(to_table, options = {})
  @base.add_foreign_key(@table_name, to_table, options)
end

#references_with_foreign_keys(*args) ⇒ Object

Adds a :foreign_key option to TableDefinition.references. If :foreign_key is true, a foreign key constraint is added to the table. You can also specify a hash, which is passed as foreign key options.

Examples
Add goat_id column and a foreign key to the goats table.
t.references(:goat, :foreign_key => true)
Add goat_id column and a cascading foreign key to the goats table.
t.references(:goat, :foreign_key => {:dependent => :delete})

Note: No foreign key is created if :polymorphic => true is used.



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/foreigner/connection_adapters/abstract/schema_definitions.rb', line 97

def references_with_foreign_keys(*args)
  options = args.extract_options!
  polymorphic = options[:polymorphic]
  fk_options = options.delete(:foreign_key)

  references_without_foreign_keys(*(args.dup << options))

  if fk_options && !polymorphic
    fk_options = {} if fk_options == true
    args.each { |to_table| foreign_key(to_table, fk_options) }
  end
end

#remove_foreign_key(options = {}) ⇒ Object

Remove the given foreign key from the table.

Examples
Remove the suppliers_company_id_fk in the suppliers table.
t.remove_foreign_key :companies
Remove the foreign key named accounts_branch_id_fk in the accounts table.
remove_foreign_key :column => :branch_id
Remove the foreign key named party_foreign_key in the accounts table.
remove_index :name => :party_foreign_key



82
83
84
 
# File 'lib/foreigner/connection_adapters/abstract/schema_definitions.rb', line 82

def remove_foreign_key(options = {})
  @base.remove_foreign_key(@table_name, options)
end