aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
diff options
context:
space:
mode:
authorJo Liss <joliss42@gmail.com>2011-12-27 13:18:34 +0100
committerJo Liss <joliss42@gmail.com>2011-12-27 13:18:34 +0100
commitdd72235225977790cb765818734e3b6adfdd4b3d (patch)
tree1ba0983b28e37e6a96a2201a7cf078d69ec4cb59 /activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
parentacab767c9d042031320b1ed7a7e2faa653ab1bb9 (diff)
downloadrails-dd72235225977790cb765818734e3b6adfdd4b3d.tar.gz
rails-dd72235225977790cb765818734e3b6adfdd4b3d.tar.bz2
rails-dd72235225977790cb765818734e3b6adfdd4b3d.zip
Document that index names are made up of all columns, not just the first.
index_name has been using the following expression "index_#{table_name}_on_#{Array.wrap(options[:column]) * '_and_'}" since at least 2006 (bc7f2315), and that's how they come out in my DB. Please check that this is correct before merging into master, perhaps I'm misunderstanding the section I changed.
Diffstat (limited to 'activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb')
-rw-r--r--activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb11
1 files changed, 2 insertions, 9 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 ccbeba061d..20d3b4a1ef 100644
--- a/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
+++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb
@@ -301,15 +301,8 @@ module ActiveRecord
# Adds a new index to the table. +column_name+ can be a single Symbol, or
# an Array of Symbols.
#
- # The index will be named after the table and the first column name,
- # unless you pass <tt>:name</tt> as an option.
- #
- # When creating an index on multiple columns, the first column is used as a name
- # for the index. For example, when you specify an index on two columns
- # [<tt>:first</tt>, <tt>:last</tt>], the DBMS creates an index for both columns as well as an
- # index for the first column <tt>:first</tt>. Using just the first name for this index
- # makes sense, because you will never have to create a singular index with this
- # name.
+ # The index will be named after the table and the column name(s), unless
+ # you pass <tt>:name</tt> as an option.
#
# ===== Examples
#