DOCSP-30756: add list search indexes to cursor page (#704)

* first draft

* first draft

* first draft

* first draft

* first draft

* first draft v1.1

* big fixes

* big fixes

* review fixes

Author: nickldp

source/code-snippets/indexes/listIndexes.js

@@ -0,0 +1,27 @@
+const { MongoClient } = require("mongodb");
+
+// Replace the following with your MongoDB deployment's connection
+// string.
+const uri =
+  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+
+const client = new MongoClient(uri);
+
+import { MongoClient } from "mongodb";
+const database = client.db("<databaseName>");
+const collection = database.collection("<collectionName>");
+
+async function run() {
+  try {
+    // start listIndexes example
+    const result = await collection.listIndexes().toArray();
+    console.log("Existing indexes:\n");
+    for(const doc in result){
+        console.log(doc);
+    }
+    // end listIndexes example
+  } finally {
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/code-snippets/indexes/listSearchIndexes.js

@@ -0,0 +1,27 @@
+const { MongoClient } = require("mongodb");
+
+// Replace the following with your MongoDB deployment's connection
+// string.
+const uri =
+  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+
+const client = new MongoClient(uri);
+
+import { MongoClient } from "mongodb";
+const database = client.db("<databaseName>");
+const collection = database.collection("<collectionName>");
+
+async function run() {
+  try {
+    // start listSearchIndexes example
+    const result = await collection.listSearchIndexes().toArray();
+    console.log("Existing search indexes:\n");
+    for(const doc in result){
+        console.log(doc);
+    }
+    // end listSearchIndexes example
+  } finally {
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/fundamentals/crud/read-operations/cursor.txt

@@ -30,6 +30,8 @@ The following functions directly return cursors:
 
 - ``Collection.listIndexes()``
 
+- ``Collection.listSearchIndexes()``
+
 - ``Db.aggregate()``
 
 - ``Db.listCollections()``
@@ -113,7 +115,7 @@ through results rather than returning all documents at once.
    :language: javascript
    :start-after: start fetchAll cursor example
    :end-before: end fetchAll cursor example
-
+ 
 Stream API
 ~~~~~~~~~~
 

source/fundamentals/indexes.txt

@@ -312,3 +312,43 @@ the following:
    E11000 duplicate key error index
 
 To learn more, see :manual:`Unique Indexes </core/index-unique>`.
+
+List Indexes
+------------
+
+You can use the ``listIndexes()`` method to list all of the indexes
+for a collection. The `listIndexes() <{+api+}/classes/Collection.html#listIndexes>`__ method takes an
+optional `ListIndexesOptions
+<{+api+}/interfaces/ListIndexesOptions.html>`__ parameter. The ``listIndexes()`` method returns an
+object of type `ListIndexesCursor
+<{+api+}/classes/ListIndexesCursor.html>`__.
+
+The following code uses the ``listIndexes()`` method to list all the
+indexes in a collection:
+
+.. literalinclude:: /code-snippets/indexes/listIndexes.js
+   :language: javascript
+   :dedent:
+   :start-after: start listIndexes example
+   :end-before: end listIndexes example
+
+List Search Indexes
+~~~~~~~~~~~~~~~~~~~
+
+When connecting to {+mdb-server+} version 7.0 or later, you can use the new `listSearchIndexes()
+<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__
+method to return a cursor that contains the search indexes of a given
+collection. The ``listSearchIndexes()`` method takes an optional string parameter, ``name``, to
+return only the indexes with matching index names. It also takes an
+optional `aggregateOptions
+<https://mongodb.github.io/node-mongodb-native/Next/interfaces/AggregateOptions.html>`__
+parameter.
+
+The following code uses the ``listSearchIndexes()`` method to list all
+the search indexes in the collection:
+
+.. literalinclude:: /code-snippets/indexes/listSearchIndexes.js
+   :language: javascript
+   :dedent:
+   :start-after: start listSearchIndexes example
+   :end-before: end listSearchIndexes example