DOCSP-22868 clustered indexes (#334)

* added clustered indexes

Author: kyuan-mongodb

snooty.toml

@@ -1,6 +1,7 @@
 name = "node"
 title = "Node.js"
 intersphinx = [
+    "https://www.mongodb.com/docs/upcoming/objects.inv",
     "https://www.mongodb.com/docs/manual/objects.inv",
     "https://www.mongodb.com/docs/drivers/objects.inv",
     "https://www.mongodb.com/docs/atlas/objects.inv",

source/fundamentals/indexes.txt

@@ -68,8 +68,8 @@ MongoDB supports a number of different index types to support querying
 your data. The following sections describe the most common index types
 and provide sample code for creating each index type.
 
-Single Field and Compound Indexes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Single Field Indexes
+~~~~~~~~~~~~~~~~~~~~
 
 **Single field indexes** are indexes that improve performance for queries
 that specify ascending or descending sort order on a single field of a
@@ -83,6 +83,7 @@ the ``sample_mflix`` database.
    :language: js
    :start-after: begin-idx
    :end-before: end-idx
+   :dedent:
 
 The following is an example of a query that would be covered by the index
 created above.
@@ -91,9 +92,12 @@ created above.
    :language: js
    :start-after: begin-query
    :end-before: end-query
+   :dedent:
 
-See the MongoDB server manual section on
-:manual:`single field indexes </core/index-single>` for more information.
+To learn more, see  :manual:`Single Field Indexes </core/index-single>`.
+
+Compound Indexes
+~~~~~~~~~~~~~~~~
 
 **Compound indexes** are indexes that improve performance for queries that
 specify ascending or descending sort order for *multiple* fields of
@@ -108,6 +112,7 @@ index on the ``type`` and ``genre`` fields in the ``movies`` collection in the
    :language: js
    :start-after: begin-idx
    :end-before: end-idx
+   :dedent:
 
 The following is an example of a query that would be covered by the index
 created above.
@@ -116,9 +121,9 @@ created above.
    :language: js
    :start-after: begin-query
    :end-before: end-query
+   :dedent:
 
-See the MongoDB server manual section on
-:manual:`Compound indexes </core/index-compound>` for more information.
+To learn more, see  :manual:`Compound Indexes </core/index-compound>`.
 
 Multikey Indexes (Indexes on Array Fields)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -136,6 +141,7 @@ the ``sample_mflix`` database.
    :language: js
    :start-after: begin-idx
    :end-before: end-idx
+   :dedent:
 
 The following is an example of a query that would be covered by the index
 created above.
@@ -144,13 +150,44 @@ created above.
    :language: js
    :start-after: begin-query
    :end-before: end-query
+   :dedent:
 
 Multikey indexes behave differently from non-multikey indexes in terms of
 query coverage, index bound computation, and sort behavior. For a full
 explanation of multikey indexes, including a discussion of their behavior
 and limitations, refer to the :manual:`Multikey Indexes page
 </core/index-multikey>` in the MongoDB manual.
 
+Clustered Indexes
+~~~~~~~~~~~~~~~~~
+
+**Clustered indexes** are indexes that improve the performance of
+insert, update, and delete operations on **clustered collections**.
+Clustered collections store documents ordered by the clustered index key
+value.
+
+To create a clustered index, specify the ``clusteredIndex`` option in
+the ``CollectionOption``. The ``clusteredIndex`` option must specify the
+``_id`` field as the key and the unique field as ``true``.
+
+The following example uses the ``createCollection()`` method to create a
+clustered index on the ``_id`` field in the ``vendors`` collection of the
+``tea`` database.
+
+.. code-block:: javascript
+   
+   const db = client.db('tea');
+   await db.createCollection('ratings', {
+     clusteredIndex: {
+       key: { _id: 1 },
+       unique: true
+     }
+   });
+
+To learn more, see 
+:ref:`Clustered Indexes <db.createCollection.clusteredIndex>` and 
+:ref:`Clustered Collections <clustered-collections>`.
+
 Text Indexes
 ~~~~~~~~~~~~
 
@@ -170,6 +207,7 @@ language.
    :language: js
    :start-after: begin-idx
    :end-before: end-idx
+   :dedent:
 
 The following is an example of a query that would be covered by the index
 created above. Note that the ``sort`` is omitted because text indexes do not
@@ -179,9 +217,9 @@ contain sort order.
    :language: js
    :start-after: begin-query
    :end-before: end-query
+   :dedent:
 
-For a full explanation of text search with MongoDB, refer to
-:manual:`Text Indexes </core/index-text>` in the MongoDB manual.
+To learn more, see :manual:`Text Indexes </core/index-text>`.
 
 Geospatial Indexes
 ~~~~~~~~~~~~~~~~~~
@@ -231,17 +269,17 @@ collection in the ``sample_mflix`` database to enable geospatial searches.
    :language: js
    :start-after: begin-idx
    :end-before: end-idx
+   :dedent:
 
 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. See the
-:manual:`Geospatial Queries page </geospatial-queries>` in the MongoDB
-server manual for more further information.
+used in MongoDB 2.2 and earlier. To learn more, see
+:manual:`Geospatial Queries </geospatial-queries>`.
 
 Unique Indexes
 ~~~~~~~~~~~~~~
 
-Unique indexes ensure that the indexed fields do not store duplicate
+**Unique indexes** ensure that the indexed fields do not store duplicate
 values. By default, MongoDB creates a unique index on the ``_id`` field
 during the creation of a collection. To create a unique index, specify the
 field or combination of fields that you want to prevent duplication on and
@@ -255,6 +293,7 @@ index on the ``theaterId`` field in the ``theaters`` collection of the
    :language: js
    :start-after: begin-idx
    :end-before: end-idx
+   :dedent:
 
 If you attempt to perform a write operation that stores a duplicate value
 that violates the unique index, MongoDB will throw an error that resembles
@@ -265,5 +304,4 @@ the following:
 
    E11000 duplicate key error index
 
-Refer to the :manual:`Unique Indexes page </core/index-unique>` in the
-MongoDB server manual for more information.
+To learn more, see :manual:`Unique Indexes </core/index-unique>`.