aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord
diff options
context:
space:
mode:
authorVipul A M <vipulnsward@gmail.com>2016-04-17 02:06:25 +0530
committerVipul A M <vipulnsward@gmail.com>2016-04-17 02:06:25 +0530
commitbca187219843fd49aba6415880d07fe8cb19f5f5 (patch)
treedc8fec49d37e4103369a4fe3afd03d88932c5cb9 /activerecord
parent39e087cbf5628ecc351fc86a3a1e320be193bf29 (diff)
parentd9565811f075273fbc3318af173fe4a21e14ae58 (diff)
downloadrails-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]
Diffstat (limited to 'activerecord')
-rw-r--r--activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb11
1 files changed, 10 insertions, 1 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)