Module: Foreigner::ConnectionAdapters::Table::InstanceMethods
- Defined in:
- lib/foreigner/connection_adapters/abstract/schema_definitions.rb
Instance Method Summary collapse
-
#foreign_key(to_table, options = {}) ⇒ Object
Adds a new foreign key to the table.
-
#references_with_foreign_keys(*args) ⇒ Object
Adds a :foreign_key option to Table.references.
-
#remove_foreign_key(options = {}) ⇒ Object
Remove the given foreign key from the table.
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)
35 36 37 |
# File 'lib/foreigner/connection_adapters/abstract/schema_definitions.rb', line 35 def foreign_key(to_table, = {}) @base.add_foreign_key(@table_name, to_table, ) end |
#references_with_foreign_keys(*args) ⇒ Object
Adds a :foreign_key option to Table.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.
63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/foreigner/connection_adapters/abstract/schema_definitions.rb', line 63 def references_with_foreign_keys(*args) = args. polymorphic = [:polymorphic] = .delete(:foreign_key) references_without_foreign_keys(*(args.dup << )) if && !polymorphic = {} if == true args.each { |to_table| foreign_key(to_table, ) } 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
48 49 50 |
# File 'lib/foreigner/connection_adapters/abstract/schema_definitions.rb', line 48 def remove_foreign_key( = {}) @base.remove_foreign_key(@table_name, ) end |