DOCSP-38493 Index Code Examples (#74)

* first pass

* feedback

Author: jordan-smith721

source/includes/indexes/indexes.py

@@ -1,79 +1,137 @@
 # start-index-single
-
+movies.create_index("title")
 # end-index-single
 
 # start-index-single-query
+query = { "title": "Batman" }
+sort = [("title", 1)]
 
+cursor = movies.find(query).sort(sort)
 # end-index-single-query
 
 # start-compound-index
-
+movies.create_index([("type", pymongo.ASCENDING), ("genre", pymongo.ASCENDING)])
 # end-compound-index
 
 # start-index-compound-query
+query = { "type": "movie", "genre": "Drama" }
+sort = [("type", pymongo.ASCENDING), ("genre", pymongo.ASCENDING)]
 
+cursor = movies.find(query).sort(sort)
 # end-index-compound-query
 
 # start-index-multikey
-
+result = movies.create_index("cast")
 # end-index-multikey
 
 # start-index-multikey-query
+query = { "cast": "Viola Davis" }
 
+cursor = movies.find(query)
 # end-index-multikey-query
 
 # start-index-text-single
-
+movies.create_index(
+    [( "plot", "text" )]
+)
 # end-index-text-single
 
 # start-index-text-single-query
+query = { "$text": { "$search": "a time-traveling DeLorean" } }
 
+cursor = movies.find(query)
 # end-index-text-single-query
 
 # start-index-text-multi
-
+result = myColl.create_index(
+    [("title", "text"), ("genre", "text")],
+    default_language="english",
+    weights={ "title": 10, "genre": 3 }
+)
 # end-index-text-multi
 
-# start-index-text-multi-query
-
-# end-index-text-multi-query
-
 # start-index-geo
-
+theaters.create_index(
+    [( "location.geo", "2dsphere" )]
+)
 # end-index-geo
 
-# start-index-geo-query
-
-# end-index-geo-query
-
 # start-index-wildcard
-
+movies.create_index({ "location.$**": pymongo.ASCENDING })
 # end-index-wildcard
 
-# start-index-clustered
+# start-index-unique
+theaters.create_index("theaterId", unique=True)
+# end-index-unique
 
+# start-index-clustered
+sample_mflix.create_collection("movies", clusteredIndex={
+    "key": { "_id": 1 }, 
+    "unique": True
+})
 # end-index-clustered
 
 # start-remove-index
-
+movies.drop_index("_title_")
 # end-remove-index
 
 # start-create-search-index
-
+index = {
+    "definition": {
+        "mappings": {
+            "dynamic": True
+        }
+    },
+    "name": "<index name>",
+}
+
+collection.create_search_index(index)
 # end-create-search-index
 
 # start-create-search-indexes
-
+index_one = {
+    "definition": {
+        "mappings": {
+            "dynamic": True
+        }
+    },
+    "name": "my_index",
+}
+
+index_two = {
+    "definition": {
+        "mappings": {
+            "dynamic": True
+        }
+    },
+    "name": "my_other_index",
+}
+
+indexes = [index_one, index_two]
+
+collection.create_search_indexes(models=indexes)
 # end-create-search-indexes
 
 # start-list-search-indexes
+results = list(collection.list_search_indexes())
 
+for index in results:
+    print(index)
 # end-list-search-indexes
 
 # start-update-search-indexes
-
+new_index = {
+    "definition": {
+        "mappings": {
+            "dynamic": True
+        }
+    },
+    "name": "my_new_index",
+}
+
+collection.update_search_index("my_index", new_index)
 # end-update-search-indexes
 
 # start-delete-search-indexes
-
+collection.drop_index("my_index")
 # end-delete-search-indexes

source/indexes/clustered-index.txt

@@ -30,7 +30,7 @@ you create your collection:
 Sample Data
 ~~~~~~~~~~~
 
-The examples in this guide use the ``sample_mflix.movies`` collection
+The examples in this guide use the ``sample_mflix`` database
 from the :atlas:`Atlas sample datasets </sample-data>`. To learn how to create a
 free MongoDB Atlas cluster and load the sample datasets, see the
 :ref:`<pymongo-get-started>`.
@@ -39,7 +39,7 @@ Create a Clustered Index
 ------------------------
 
 The following example creates a clustered index on the ``_id`` field in
-the ``vendors`` collection:
+a new ``movie_reviews`` collection:
 
 .. literalinclude:: /includes/indexes/indexes.py
    :language: python

source/indexes/compound-index.txt

@@ -34,7 +34,7 @@ free MongoDB Atlas cluster and load the sample datasets, see the
 Create a Compound Index
 -----------------------
 
-The following example creates a compound index on the ``type`` and ``rated`` fields:
+The following example creates a compound index on the ``type`` and ``genre`` fields:
 
 .. literalinclude:: /includes/indexes/indexes.py
    :language: python

source/indexes/geospatial-index.txt

@@ -31,7 +31,7 @@ Server manual.
 Sample Data
 ~~~~~~~~~~~
 
-The examples in this guide use the ``sample_mflix.movies`` collection
+The examples in this guide use the ``sample_mflix.theaters`` collection
 from the :atlas:`Atlas sample datasets </sample-data>`. To learn how to create a
 free MongoDB Atlas cluster and load the sample datasets, see the
 :ref:`<pymongo-get-started>`.
@@ -71,13 +71,6 @@ The following example creates a ``2dsphere`` index on the ``location.geo`` field
    :start-after: start-index-geo
    :end-before: end-index-geo
 
-The following is an example of a geospatial query using the "location.geo" index.
-
-.. literalinclude:: /includes/indexes/indexes.py
-   :language: python
-   :start-after: start-index-geo-query
-   :end-before: end-index-geo-query
-
 MongoDB also supports ``2d`` indexes for calculating distances on a Euclidean plane and for working with the "legacy
 coordinate pairs" syntax used in MongoDB 2.2 and earlier. For more information,
 see the :manual:`Geospatial Queries guide </geospatial-queries>` in the MongoDB

source/indexes/multikey-index.txt

@@ -34,8 +34,7 @@ free MongoDB Atlas cluster and load the sample datasets, see the
 Create a Multikey Index
 -----------------------
 
-The following example creates a multikey index on the ``rated``, ``genres``, and
-``title`` fields:
+The following example creates a multikey index on the ``cast`` field:
 
 .. literalinclude:: /includes/indexes/indexes.py
    :language: python

source/indexes/single-field-index.txt

@@ -40,7 +40,7 @@ free MongoDB Atlas cluster and load the sample datasets, see the
 Create Single-Field Index
 -------------------------
 
-The following example creates an index in ascending order on the ``name`` field:
+The following example creates an index in ascending order on the ``title`` field:
 
 .. literalinclude:: /includes/indexes/indexes.py
    :start-after: start-index-single

source/indexes/unique-index.txt

@@ -30,7 +30,7 @@ of a collection. To create a unique index, perform the following steps:
 Sample Data
 ~~~~~~~~~~~
 
-The examples in this guide use the ``sample_mflix.movies`` collection
+The examples in this guide use the ``sample_mflix.theaters`` collection
 from the :atlas:`Atlas sample datasets </sample-data>`. To learn how to create a
 free MongoDB Atlas cluster and load the sample datasets, see the
 :ref:`<pymongo-get-started>`.
@@ -42,8 +42,8 @@ The following example creates a descending unique index on the ``theaterId`` fie
 
 .. literalinclude:: /includes/indexes/indexes.py
    :language: python
-   :start-after: start-index-geo-query
-   :end-before: end-index-geo-query
+   :start-after: start-index-unique
+   :end-before: end-index-unique
 
 For more information, see the :manual:`Unique Indexes </core/index-unique>` guide
 in the MongoDB Server manual.

source/work-with-indexes.txt

@@ -104,8 +104,8 @@ Remove a Single Index
 Pass an instance of an index or the index name to the ``drop_index()`` method to
 remove an index from a collection.
 
-The following example removes an ascending index on the ``title`` field
-in a collection:
+The following example removes an index with the name ``"_title_"`` from the ``movies``
+collection:
 
 .. literalinclude:: /includes/indexes/indexes.py
    :language: python