Merge branch 'v6.9' of github.com:mongodb/docs-node into v6.9

Author: lindseymoore

source/code-snippets/indexes/text.js

@@ -17,8 +17,10 @@ async function run() {
     // Create a text index on the "title" and "body" fields
     const result = await myColl.createIndex(
       { title: "text", body: "text" },
-      { default_language: "english" },
-      { weights: { body: 10, title: 3 } }
+      {
+         default_language: "english",
+         weights: { body: 10, title: 3 }
+      }
     );
     // end-idx
     console.log(`Index created: ${result}`);

source/faq.txt

@@ -122,12 +122,9 @@ What Is the Difference Between "connectTimeoutMS", "socketTimeoutMS" and "maxTim
        <node-connection-options>` that sets the time, in milliseconds,
        for an individual connection from your connection pool to
        establish a TCP connection to the {+mdb-server+} before
-       timing out.
-
-       .. tip::
-
-          To modify the allowed time for `MongoClient.connect <{+api+}/classes/MongoClient.html#connect>`__ to establish a
-          connection to a {+mdb-server+}, use the ``serverSelectionTimeoutMS`` option instead.
+       timing out. To modify the allowed time for 
+       `MongoClient.connect <{+api+}/classes/MongoClient.html#connect>`__ to establish a  
+       connection to a {+mdb-server+}, use the ``serverSelectionTimeoutMS`` option instead.
 
        **Default:** 30000
    * - **socketTimeoutMS**
@@ -170,9 +167,7 @@ What Happens to Running Operations if the Client Disconnects?
 
 Starting in {+mdb-server+} version 4.2, the server terminates
 running operations such as aggregations and find operations if the
-client disconnects. To see a full list of operations affected by this
-behavior, see the :manual:`Server version 4.2 release notes
-</release-notes/4.2/#client-disconnection>` in the Server manual.
+client disconnects.
 
 Other operations, such as write operations, continue to run on the
 {+mdb-server+} even if the client disconnects. This behavior can cause data

source/fundamentals/authentication/mechanisms.txt

@@ -229,7 +229,29 @@ The driver checks for your credentials in the following sources in order:
 
          export AWS_WEB_IDENTITY_TOKEN_FILE=<absolute path to file containing your OIDC token>
 
-      After you've set the preceding environment variable, specify the ``MONGODB-AWS``
+      AWS recommends using regional AWS STS endpoints instead of global 
+      endpoints to reduce latency, build-in redundancy, and increase session token validity.
+      To set the AWS region, set `AWS_REGION <https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html>`__ 
+      and `AWS_STS_REGIONAL_ENDPOINTS <https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html>`__
+      as environment variables, as shown in the following example: 
+
+      .. code-block:: bash
+         
+         export AWS_STS_REGIONAL_ENDPOINTS=regional // Enables regional endpoints
+         export AWS_REGION=us-east-1 // Sets your AWS region
+         
+      If both these environment variables aren't set, the default region is 
+      ``us-east-1``. For a list of available AWS regions, see the
+      `Regional Endpoints <https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints>`__ 
+      section of the AWS Service Endpoints reference in the AWS documentation. 
+
+      .. warning:: Consult your SDK's Documentation for Setting an AWS Region
+
+         You cannot set your AWS region with environment variables for all SDKs,
+         as in the above example. See your SDK's specific documentation for 
+         configuring an AWS region. 
+
+      After you've set the preceding environment variables, specify the ``MONGODB-AWS``
       authentication mechanism in your connection string as shown in the following example:
 
       .. literalinclude:: /code-snippets/authentication/aws-env-variable.js

source/fundamentals/connection/connection-options.txt

@@ -53,6 +53,21 @@ parameters of the connection URI to specify the behavior of the client.
      - ``null``
      - Specifies the database that connections authenticate against.
 
+   * - **autoSelectFamily**
+     - boolean
+     - ``true``
+     - If set to ``true``, the socket attempts to connect to IPv6 and IPv4 addresses
+       until a connection is established. If available, the driver will select 
+       the first IPv6 address.
+
+   * - **autoSelectFamilyAttemptTimeout**
+     - non-negative integer
+     - ``null``
+     - Specifies the amount of time in milliseconds to wait for a connection
+       attempt to finish before trying the next address when using the 
+       ``autoSelectFamily`` option. If set to a positive integer less than ``10``,
+       the value ``10`` is used instead.
+
    * - **compressors**
      - comma separated list of strings, for example, "snappy,zlib,zstd"
      - ``null``
@@ -321,6 +336,8 @@ parameters of the connection URI to specify the behavior of the client.
      - ``0``
      - Specifies the amount of time, in milliseconds, spent attempting to check out a connection
        from a server's connection pool before timing out.
+       
+       ``0`` signifies no timeout.
 
    * - **wTimeoutMS**
      - non-negative integer

source/fundamentals/connection/network-compression.txt

@@ -55,7 +55,7 @@ by specifying the algorithms in one of two ways:
    .. tab:: MongoClientOptions
       :tabid: mongoclientoptions
 
-      To enable compression using the `MongoClientOptions <{+api+}/api/global.html#MongoClientOptions>`__,
+      To enable compression using the `MongoClientOptions <{+api+}/interfaces/MongoClientOptions.html>`__,
       pass the ``compressors`` option and the compression
       algorithm you want to use. You can specify one or more compression
       algorithms, separating them with commas:

source/fundamentals/indexes.txt

@@ -71,7 +71,7 @@ List Indexes
 You can use the ``listIndexes()`` method to list all 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
+<{+api+}/types/ListIndexesOptions.html>`__ parameter. The ``listIndexes()`` method returns an
 object of type `ListIndexesCursor
 <{+api+}/classes/ListIndexesCursor.html>`__.
 

source/fundamentals/run-command.txt

@@ -1,8 +1,8 @@
 .. _node-run-command:
 
-=============
+==============
 Run a Command
-=============
+==============
 
 .. contents:: On this page
    :local:
@@ -141,12 +141,9 @@ with the following fields:
 
    * - ``operationTime``
      - Indicates the logical time of the operation. MongoDB uses the
-       logical time to order operations.
-       
-       .. seealso::
-  
-          To learn more about logical time, see our :website:`blog post about
-          the Global Logical Clock </blog/post/transactions-background-part-4-the-global-logical-clock>`.
+       logical time to order operations. 
+       To learn more about logical time, see our 
+       :website:`blog post about the Global Logical Clock </blog/post/transactions-background-part-4-the-global-logical-clock>`.
 
    * - ``$clusterTime``
      - Provides a document that returns the signed cluster time. Cluster time is a

source/fundamentals/transactions.txt

@@ -208,6 +208,8 @@ the Convenient Transaction API:
 To see a fully runnable example that uses this API, see the
 :ref:`node-usage-convenient-txn` usage example.
 
+.. sharedinclude:: dbx/transactions-parallelism.rst
+
 .. _nodejs-transaction-settings:
 
 Transaction Options

source/includes/figures/atlas_connect.png

@@ -24,34 +24,32 @@ To connect to an instance or deployment not hosted on Atlas, see
       To retrieve your connection string for the deployment that
       you created in the :ref:`previous step <node-quick-start-create-deployment>`,
       log into your Atlas account and navigate to the
-      :guilabel:`Database` section and click the :guilabel:`Connect` button
+      :guilabel:`Clusters` section and click the :guilabel:`Connect` button
       for your new deployment.
 
-      .. figure:: /includes/figures/atlas_connection_select_cluster.png
+      .. figure:: /includes/figures/atlas_connect.png
          :alt: The connect button in the clusters section of the Atlas UI
 
-      Proceed to the :guilabel:`Connect your application` section and select
-      "Node.js" from the :guilabel:`Driver` selection menu and the version
+      Select the :guilabel:`Drivers` option from the :guilabel:`Connect to your application` 
+      section. Then in the :guilabel:`Connecting with MongoDB Driver` 
+      menu, select "Node.js" from the :guilabel:`Driver` selection menu and the version
       that best matches the version you installed from the :guilabel:`Version`
       selection menu.
 
       Select the :guilabel:`Password (SCRAM)` authentication mechanism.
-      
-      Deselect the :guilabel:`Include full driver code example` to view
-      the connection string.
 
    .. step:: Copy your Connection String
 
       Click the button on the right of the connection string to copy it to
       your clipboard as shown in the following screenshot:
 
-      .. figure:: /includes/figures/atlas_connection_copy_string_node.png
+      .. figure:: /includes/figures/atlas_connection_copy_string.png
          :alt: The connection string copy button in the Atlas UI
 
    .. step:: Update the Placeholders
 
       Paste this connection string into a a file in your preferred text editor
-      and replace the "<username>" and "<password>" placeholders with
+      and replace the "<db_username>" and "<db_password>" placeholders with
       your database user's username and password.
 
       Save this file to a safe location for use in the next step.

source/includes/figures/atlas_connection_copy_string.png

@@ -7,9 +7,9 @@
 .. meta::
    :keywords: code example, multiple, modify, customize, debug
 
-=============
-Run a Command
-=============
+=====================
+Run a Command Example
+=====================
 
 You can execute database commands by using the
 `command() <{+api+}/classes/Db.html#command>`__ method on a ``Db``

source/includes/figures/atlas_connection_copy_string_node.png

@@ -83,7 +83,7 @@ What's New in 6.9
 - Adds official support for Queryable Encryption (QE) range queries. To use this
   feature, your app must use ``mongodb-client-encryption`` v6.1.0 or later and must connect
   to {+mdb-server+} 8.0 or later. For more information about QE range queries, see
-  :manual:`Queryable Encryption <core/queryable-encryption>` in the {+mdb-server+} manual.
+  :manual:`Queryable Encryption </core/queryable-encryption>` in the {+mdb-server+} manual.
 
 - The ``insertMany()`` and ``bulkWrite()`` methods accept ``ReadonlyArray`` inputs.
 
@@ -450,14 +450,19 @@ The {+driver-short+} v6.1 release includes the following features:
   ``Decimal128.fromStringWithRounding()`` method. To learn more, see the
   `v6.1.0 bson release notes <https://github.com/mongodb/js-bson/releases/tag/v6.1.0>`__.
 
-- Detects environment variables for region settings when
-  authenticating by using the ``MONGODB-AWS`` authentication mechanism.
-  To instruct the driver to use your region options, you must set both
-  of the following environment variables:
+- Detects environment variables for region settings when you
+  authenticate by using the `IAM AssumeRoleWithWebIdentity action
+  <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`__ 
+  with ``MONGODB-AWS`` authentication. To instruct the driver to use your region options, 
+  you must set both of the following environment variables:
 
   - ``AWS_STS_REGIONAL_ENDPOINTS``
   - ``AWS_REGION``
 
+  To learn how to set region settings when using the ``MONGODB-AWS`` 
+  authentication mechanism, see the :guilabel:`Web Identity Token` tab in the 
+  :ref:`MONGODB-AWS <mongodb-aws>` section of the Authentication Mechanisms guide. 
+
 - Fixes a memory leak issue caused by recursive calls to the ``next()``
   method of the ``ChangeStream`` type.
 
@@ -540,4 +545,4 @@ The {+driver-short+} v6.0 release includes the following features:
   <node-command-options>` section of the Run a Command guide.
 
 To learn more about this release, see the
-`v6.0.0 Release Highlights <https://github.com/mongodb/node-mongodb-native/releases/tag/v6.0.0>`__.
+`v6.0.0 Release Highlights <https://github.com/mongodb/node-mongodb-native/releases/tag/v6.0.0>`__.