Edits

Author: mayaraman19

source/includes/reference/indexes.rb

@@ -23,6 +23,12 @@ class Restaurant
 # end create alias index
 
 # start create embedded index
+class Address
+    include Mongoid::Document
+
+    field :street, type: String
+end
+
 class Restaurant
     include Mongoid::Document
 
@@ -38,15 +44,15 @@ class Restaurant
     field :name, type: String
     embeds_many :addresses
 
-    index({"addresses.street": 1, name: -1}, { name: "compound_index"})
+    index({borough: 1, name: -1}, { name: "compound_index"})
 end
 # end create compound index
 
 # start create 2dsphere index
 class Restaurant
     include Mongoid::Document
 
-    field :location, type: Point
+    field :location, type: Array
 
     index({location: "2dsphere"}, { name: "location_index"})
 end
@@ -64,10 +70,6 @@ class Restaurant
 end
 # end create sparse index
 
-# start list index
-Restaurant.indexes.each { |index| puts index }
-# end list index
-
 # start create multiple indexes
 class Restaurant
     include Mongoid::Document
@@ -95,7 +97,18 @@ class Restaurant
     field :cuisine, type: String
     field :borough, type: String
 
-    search_index({ name: 1})
+    search_index :my_search_index, 
+        mappings: { 
+            fields: { 
+                name: { 
+                    type: "string" 
+                },
+                cuisine: {
+                    type: "string"
+                }
+            }, 
+            dynamic: true 
+        }
 end
 
 Restaurant.create_search_indexes

source/reference/indexes.txt

@@ -9,7 +9,7 @@ Work With Indexes
 .. contents:: On this page
    :local:
    :backlinks: none
-   :depth: 2
+   :depth: 3
    :class: singlecol
 
 Overview
@@ -44,9 +44,12 @@ named ``cuisine_index`` on the ``cuisine`` field in the ``Restaurant`` class:
   :end-before: end create index
 
 The ``index`` macro defines the index you want to create and the ``create_index``
-macro creates the index in the ``restaurants`` collection. When defining an 
-index, the field you want to index on goes in the first hash object, and the
-index options go in the second hash object.
+macro creates the index in the ``restaurants`` collection. 
+
+When defining an index, the first hash object contains the field you want to
+index and its direction. ``1`` represents an ascending index, ``-1`` represents a
+descending index. The second hash object contains index options. To learn more
+about index options, see the :ref:`mongoid_indexes_api_documentation` section.
 
 Aliases and Declaring Indexes
 +++++++++++++++++++++++++++++
@@ -98,10 +101,10 @@ objects:
   :start-after: start create 2dsphere index
   :end-before: end create 2dsphere index
 
-For more information on 2dsphere indexes, see the :manual:`2dsphere <core/indexes/index-types/geospatial/2dsphere/>`
+For more information on 2dsphere indexes, see the :manual:`2dsphere </core/indexes/index-types/geospatial/2dsphere/>`
 guide in the {+mdb-server+} manual.
 
-For more information on the GeoJSON type, see the :manual:`GeoJSON Objects <reference/geojson/>`
+For more information on the GeoJSON type, see the :manual:`GeoJSON Objects </reference/geojson/>`
 guide in the {+mdb-server+} manual.
 
 Create a Sparse Index
@@ -115,7 +118,7 @@ The following code example defines a sparse index on the ``borough`` field:
   :start-after: start create sparse index
   :end-before: end create sparse index
 
-For more information on sparse indexes, see the :manual:`Sparse Indexes <core/index-sparse/>`
+For more information on sparse indexes, see the :manual:`Sparse Indexes </core/index-sparse/>`
 guide in the {+mdb-server+} manual.
 
 Create Multiple Indexes
@@ -130,21 +133,6 @@ indexes at the same time:
   :start-after: start create multiple indexes
   :end-before: end create multiple indexes
 
-.. TODO checkout what databases does
-
-List Indexes
-~~~~~~~~~~~~
-
-You can list all indexes in your collection. The following example prints all 
-indexes in the ``Restaurant`` model:
-
-.. literalinclude:: /includes/reference/indexes.rb
-  :language: ruby
-  :start-after: start list index
-  :end-before: end list index
-
-.. TODO test if there's a way to drop single index
-
 Drop Indexes
 ~~~~~~~~~~~~
 
@@ -156,21 +144,32 @@ indexes in the ``Restaurant`` model:
   :start-after: start drop indexes
   :end-before: end drop indexes
 
-.. TODO: Is there a way to only drop 1
+.. note:: Default Index
+   
+   MongoDB creates a default index on the ``_id`` field during the
+   creation of a collection. This index prevents clients from inserting
+   two documents with the same values for the ``_id`` field. You cannot
+   drop this index. 
 
 Atlas Search Indexes
 ~~~~~~~~~~~~~~~~~~~~
 
 You can declare and manage Atlas Search indexes using {+odm+}.
 
 To declare a search index, use the ``search_index`` macro within your model. The
-following code example shows how to declare and create an Atlas Search index:
+following code example shows how to declare and create an Atlas Search index 
+named ``my_search_index``.
+The index is on the ``name`` and ``cuisine`` fields and is dynamic.
 
 .. literalinclude:: /includes/reference/indexes.rb
   :language: ruby
   :start-after: start create atlas search index
   :end-before: end create atlas search index
 
+To learn more about the syntax for creating an Atlas Search index, see
+the :atlas:`Create an Atlas Search Index </atlas-search/create-index/#std-label-ref-create-index>`
+guide in the MongoDB Atlas documentation.
+
 Remove an Atlas Search Index
 ++++++++++++++++++++++++++++
 
@@ -186,14 +185,28 @@ following code example shows how to remove an Atlas Search index from the
 List Atlas Search Indexes
 +++++++++++++++++++++++++
 
-You can list all Atlas Search indexes in your collection by using the 
-``search_indexes`` macro:
+You can enumerate through all Atlas Search indexes in your collection 
+by using the ``search_indexes`` macro. The following example enumerates through
+all Atlas Search indexes in the ``restaurants`` collection and prints out their
+information:
 
 .. literalinclude:: /includes/reference/indexes.rb
+  :language: ruby
+  :start-after: start list atlas search index
+  :end-before: end list atlas search index
+
+.. _mongoid-indexes-api-documentation:
 
 API Documentation
 -----------------
 
 To learn more about using indexes in {+odm+}, see the 
 `Mongoid::Indexable::ClassMethods <{+api-root+}/Indexable/ClassMethods.html>`__
-guide.
+documentation.
+
+To learn more about index options, see the `Mongoid::Indexable::Validators::Options
+<{+api-root+}/Indexable/Validators/Options.html>`__ documentation.
+
+To learn more about using Atlas Search indexes in {+odm+}, see the 
+`Mongoid::SearchIndexable::ClassMethods <{+api-root+}/SearchIndexable/ClassMethods.html>`__
+documentation.