JM tech review 1

Author: rustagir

source/includes/usage-examples/index-code-examples.php

@@ -2,13 +2,21 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-use MongoDB\Client;
+$uri = getenv('MONGODB_URI') ?: throw new RuntimeException('Set the MONGODB_URI variable to your Atlas URI that connects to the sample dataset');
+$client = new MongoDB\Client($uri);
 
-$client = new Client('<connection string>');
-$collection = $client-><database>-><collection>;
+$database = $client->sample_db;
+$collection = $database->sample_coll;
+
+// start-to-json
+function toJSON(object $document): string
+{
+    return MongoDB\BSON\Document::fromPHP($document)->toRelaxedExtendedJSON();
+}
+// end-to-json
 
 // start-single-field
-$result = $collection->createIndex(['<field name>' => 1]);
+$indexName = $collection->createIndex(['<field name>' => 1]);
 // end-single-field
 
 // start-compound
@@ -18,49 +26,57 @@
 // end-compound
 
 // start-multikey
-$result = $collection->createIndex(['<array field name>' => 1]);
+$indexName = $collection->createIndex(['<array field name>' => 1]);
 // end-multikey
 
 // start-search-create
-$result = $collection->createSearchIndex(
+$indexName = $collection->createSearchIndex(
     ['mappings' => ['dynamic' => true]],
     ['name' => '<index name>']
 );
 // end-search-create
 
 // start-search-list
 foreach ($collection->listSearchIndexes() as $indexInfo) {
-    var_dump($indexInfo);
+    echo toJSON($indexInfo) . PHP_EOL;
 }
 // end-search-list
 
 // start-search-update
-$result = $collection->updateSearchIndex(
-    ['name' => '<index name>'],
-    ['mappings' => ['dynamic' => true]],
+$collection->updateSearchIndex(
+    ['name' => '<Search name>'],
+    ['mappings' => [
+        'dynamic' => false,
+        'fields' => [
+            '<string field name>' => [
+                'type' => 'string',
+                'analyzer' => 'lucene.standard'
+            ]
+        ]
+    ]]
  );
 // end-search-update
 
 // start-search-delete
-$result = $collection->dropIndex('<index name>');
+$collection->dropSearchIndex('<Search index name>');
 // end-search-delete
 
 // start-text
-$result = $collection->createIndex(['<field name>' => 'text']);
+$indexName = $collection->createIndex(['<field name>' => 'text']);
 // end-text
 
 // start-geo
-$result = $collection->createIndex(
-    [ '<GeoJSON object field>' => '2dsphere'], ['name' => '<index name>']
+$indexName = $collection->createIndex(
+    [ '<GeoJSON object field>' => '2dsphere']
 );
 // end-geo
 
 // start-unique
-$result = $collection->createIndex(['<field name>' => 1], ['unique' => true]);
+$indexName = $collection->createIndex(['<field name>' => 1], ['unique' => true]);
 // end-unique
 
 // start-wildcard
-$result = $collection->createIndex(['$**' => 1]);
+$indexName = $collection->createIndex(['$**' => 1]);
 // end-wildcard
 
 // start-clustered
@@ -76,10 +92,10 @@
 
 // start-list
 foreach ($collection->listIndexes() as $indexInfo) {
-    var_dump($indexInfo);
+    echo toJSON($indexInfo) . PHP_EOL;
 }
 // end-list
 
 // start-remove
-$result = $collection->dropIndex('<index name>');
+$collection->dropIndex('<index name>');
 // end-remove

source/indexes.txt

@@ -53,6 +53,16 @@ target namespace.
    :linenos:
    :emphasize-lines: 10-12
 
+Some examples use the ``toJSON()`` function to represent change events, which are BSON 
+documents, as Extended JSON. To use this function, paste the following code into your
+application file:
+
+.. literalinclude:: /includes/usage-examples/index-code-examples.php
+   :language: php
+   :dedent:
+   :start-after: start-to-json
+   :end-before: end-to-json
+
 Single Field Index
 ------------------
 
@@ -112,6 +122,9 @@ that has GeoJSON object values:
    :copyable:
    :dedent:
 
+To learn more about the GeoJSON data type, see :manual:`GeoJSON Objects
+</reference/geojson/>` in the {+mdb-server+} manual.
+
 .. TODO: To learn more about geospatial indexes, see the :ref:`php-geospatial-index`
 .. guide.
 
@@ -164,12 +177,62 @@ ascending clustered index on the ``_id`` field:
 .. TODO: To learn more about clustered indexes, see the :ref:`php-clustered-index`
 .. guide.
 
+Text Index
+----------
+
+The following example creates a text index on the specified string field:
+
+.. literalinclude:: /includes/usage-examples/index-code-examples.php
+   :start-after: start-text
+   :end-before: end-text
+   :language: php
+   :copyable:
+   :dedent:
+
+.. TODO: To learn more about text indexes, see the :ref:`php-text-index`
+.. guide.
+
+List Indexes
+------------
+
+The following example prints a list of indexes in the
+specified collection:
+
+.. literalinclude:: /includes/usage-examples/index-code-examples.php
+   :start-after: start-list
+   :end-before: end-list
+   :language: php
+   :copyable:
+   :dedent:
+
+Delete an Index
+---------------
+
+The following example deletes an index with the specified name:
+
+.. literalinclude:: /includes/usage-examples/index-code-examples.php
+   :start-after: start-remove
+   :end-before: end-remove
+   :language: php
+   :copyable:
+   :dedent:
+
+.. TODO: To learn more about removing indexes, see :ref:`php-indexes-remove`
+.. in the Work with Indexes guide.
+
 Atlas Search Index Management
 -----------------------------
 
 The following sections contain code examples that describe how to manage
 :atlas:`Atlas Search indexes </atlas-search/manage-indexes/>`. 
 
+.. note:: Search Index Management is Asynchronous
+
+   The {+php-library+} manages Atlas Search indexes asynchronously. The
+   library methods described in the following sections return the server
+   response immediately, but the changes to your Search indexes take
+   place in the background and might not complete until some time later.
+
 .. To learn more about Atlas Search indexes, see the :ref:`php-atlas-search-index`
 .. guide.
 
@@ -233,47 +296,4 @@ The following example deletes an Atlas Search index with the specified name:
    :dedent:
 
 .. To learn more about deleting search indexes, see the :ref:`php-atlas-search-index-drop`
-.. guide.
-
-Text Index
-----------
-
-The following example creates a text index on the specified string field:
-
-.. literalinclude:: /includes/usage-examples/index-code-examples.php
-   :start-after: start-text
-   :end-before: end-text
-   :language: php
-   :copyable:
-   :dedent:
-
-.. TODO: To learn more about text indexes, see the :ref:`php-text-index`
-.. guide.
-
-List Indexes
-------------
-
-The following example prints a list of indexes in the
-specified collection:
-
-.. literalinclude:: /includes/usage-examples/index-code-examples.php
-   :start-after: start-list
-   :end-before: end-list
-   :language: php
-   :copyable:
-   :dedent:
-
-Delete an Index
----------------
-
-The following example deletes an index with the specified name:
-
-.. literalinclude:: /includes/usage-examples/index-code-examples.php
-   :start-after: start-remove
-   :end-before: end-remove
-   :language: php
-   :copyable:
-   :dedent:
-
-.. TODO: To learn more about removing indexes, see :ref:`php-indexes-remove`
-.. in the Work with Indexes guide.
+.. guide.