diff options
| author | Vipul A M <vipulnsward@gmail.com> | 2016-04-17 02:06:25 +0530 |
|---|---|---|
| committer | Vipul A M <vipulnsward@gmail.com> | 2016-04-17 02:06:25 +0530 |
| commit | bca187219843fd49aba6415880d07fe8cb19f5f5 (patch) | |
| tree | dc8fec49d37e4103369a4fe3afd03d88932c5cb9 | |
| parent | 39e087cbf5628ecc351fc86a3a1e320be193bf29 (diff) | |
| parent | d9565811f075273fbc3318af173fe4a21e14ae58 (diff) | |
| download | rails-bca187219843fd49aba6415880d07fe8cb19f5f5.tar.gz rails-bca187219843fd49aba6415880d07fe8cb19f5f5.tar.bz2 rails-bca187219843fd49aba6415880d07fe8cb19f5f5.zip | |
documentation for add_references index option [ci skip]
documentation for add_references index option [ci skip]
| -rw-r--r-- | activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb | 11 | ||||
| -rw-r--r-- | guides/source/active_record_migrations.md | 3 |
2 files changed, 12 insertions, 2 deletions
diff --git a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb index 020d9bbdca..da0c961142 100644 --- a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb +++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb @@ -776,7 +776,8 @@ module ActiveRecord # [<tt>:type</tt>] # The reference column type. Defaults to +:integer+. # [<tt>:index</tt>] - # Add an appropriate index. Defaults to false. + # Add an appropriate index. Defaults to false. + # See #add_index for usage of this option. # [<tt>:foreign_key</tt>] # Add an appropriate foreign key constraint. Defaults to false. # [<tt>:polymorphic</tt>] @@ -796,6 +797,14 @@ module ActiveRecord # # add_reference(:products, :supplier, polymorphic: true, index: true) # + # ====== Create a supplier_id column with a unique index + # + # add_reference(:products, :supplier, index: { unique: true }) + # + # ====== Create a supplier_id column with a named index + # + # add_reference(:products, :supplier, index: { name: "my_supplier_index" }) + # # ====== Create a supplier_id column and appropriate foreign key # # add_reference(:products, :supplier, foreign_key: true) diff --git a/guides/source/active_record_migrations.md b/guides/source/active_record_migrations.md index b89485b945..004a30d669 100644 --- a/guides/source/active_record_migrations.md +++ b/guides/source/active_record_migrations.md @@ -246,7 +246,8 @@ class AddUserRefToProducts < ActiveRecord::Migration[5.0] end ``` -This migration will create a `user_id` column and appropriate index. +This migration will create a `user_id` column and appropriate index. +For more `add_reference` options, visit the [API documentation](http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-add_reference). There is also a generator which will produce join tables if `JoinTable` is part of the name: |