aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/connection_adapters
diff options
context:
space:
mode:
authorWaseem Ahmad <talk.to.waseem@gmail.com>2012-03-02 01:28:30 +0530
committerWaseem Ahmad <talk.to.waseem@gmail.com>2012-03-02 01:28:30 +0530
commit92887ca315d20d55959d950438b98e4c876fc57b (patch)
tree28ab4ec0ba9098204fef114b3d53ce4b3a5b8973 /activerecord/lib/active_record/connection_adapters
parent5f92bf1ca0dc48d3657f8a419fcf5a819353744f (diff)
downloadrails-92887ca315d20d55959d950438b98e4c876fc57b.tar.gz
rails-92887ca315d20d55959d950438b98e4c876fc57b.tar.bz2
rails-92887ca315d20d55959d950438b98e4c876fc57b.zip
Add documentation for IndexDefinition.
Diffstat (limited to 'activerecord/lib/active_record/connection_adapters')
-rw-r--r--activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb b/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb
index ad2e8634eb..7ee8f40631 100644
--- a/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb
+++ b/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb
@@ -6,6 +6,9 @@ require 'bigdecimal/util'
module ActiveRecord
module ConnectionAdapters #:nodoc:
+ # Abstract representation of an index definition on a table. Instances of
+ # this type are typically created and returned by methods in database
+ # adapters. e.g. ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter#indexes
class IndexDefinition < Struct.new(:table, :name, :unique, :columns, :lengths, :orders, :where) #:nodoc:
end