Small doc on index

mongoid · Sep 23, 2009 · e044ecf · e044ecf
1 parent 5a98b2b
commit e044ecf
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/mongoid/document.rb b/lib/mongoid/document.rb
@@ -89,6 +89,8 @@ def has_one(association_name)
         add_association(:has_one, association_name.to_s.titleize, association_name)
       end
 
+      # Adds an index on the field specified. Options can be :unique => true or
+      # :unique => false. It will default to the latter.
       def index(name, options = { :unique => false })
         collection.create_index(name, options)
       end