table format

rachel-mack · rachel-mack · commit 3ea91aed9585 · 2025-03-18T11:48:54.000-04:00
diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt
@@ -7,7 +7,8 @@ Specify Connection Options
 .. toctree::
 
    Connection URI Options </connection/specify-connection-options/connection-options>
-   MongoClient Settings </connection/specify-connection-options/mongoclientsettings>
+   MongoClient Settings
+   </connection/specify-connection-options/mongoclientsettings>
    Stable API </connection/specify-connection-options/stable-api>
    Connection Pools </connection/specify-connection-options/connection-pools>
    Cluster Settings </connection/specify-connection-options/cluster-settings>
diff --git a/source/connection/specify-connection-options/cluster-settings.txt b/source/connection/specify-connection-options/cluster-settings.txt
@@ -22,7 +22,7 @@ Overview
 
 In this guide, you can learn about how the {+driver-short+} manages clusters.
 
-You can specify settings for your clusters using either a :ref:`connection
+You can specify settings for your clusters by using either a :ref:`connection
 string <connection-uri>` or by passing a ``MongoClientSettings`` object to the 
 :ref:`MongoClients <mongoclient>` constructor. Select the :guilabel:`Connection
 String` or :guilabel:`MongoClientSettings` tab to see the options available:
@@ -43,56 +43,56 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
         
        * - **serverSelectionTimeoutMS**
          - integer
-         - | Specifies the maximum amount of time, in milliseconds, the driver
-              will wait for server selection to succeed before throwing an
-              exception. 
-            |
-            | **Default**: ``30000`` (30 seconds)
+         - Specifies the maximum amount of time, in milliseconds, the driver
+           will wait for server selection to succeed before throwing an
+           exception. 
+            
+           **Default**: ``30000`` (30 seconds)
         
        * - **localThresholdMS**
          - integer
-         - | When communicating with multiple instances of MongoDB in a replica
+         - When communicating with multiple instances of MongoDB in a replica
               set, the driver will only send requests to a server whose response
               time is less than or equal to the server with the fastest response
               time plus the local threshold, in milliseconds. 
-            |
-            | **Default**: ``15``
+            
+           **Default**: ``15``
         
        * - **heartbeatFrequencyMS**
          - integer
-         - Specifies the frequency, in milliseconds that the driver will wait
-            between attempts to determine the current state of each server in
-            the cluster. 
-            |
-            | **Default**: ``10000`` (10 seconds)
+         -  Specifies the frequency, in milliseconds that the driver will wait
+             between attempts to determine the current state of each server in
+             the cluster.  
+           
+            **Default**: ``10000`` (10 seconds)
         
        * - **replicaSet**
          - string
          - Specifies that the :ref:`connection string <connection-uri>`
             provided includes multiple hosts. When specified, the driver
             attempts to find all members of that set. 
-            |
-            | **Default**: ``null``
+            
+           **Default**: ``null``
         
        * - **directConnection**
          - boolean
          - Specifies that the driver must connect to the host directly. This
             maps to applying ``mode(ClusterConnectionMode.SINGLE)`` to your
             ``MongoClientSettings``. 
-            |
-            | **Default**: ``false``
+            
+           **Default**: ``false``
         
        * - **srvServiceName**
          - string
-         - | Specifies the service name of the `SRV resource records
-            <https://www.rfc-editor.org/rfc/rfc2782>`__ the driver retrieves to
-            construct your :manual:`seed list
-            </reference/glossary/#std-term-seed-list>`. You must use the
-            :manual:`DNS Seed List Connection Format
-            </reference/connection-string/#dns-seed-list-connection-format>` in
-            your :ref:`connection URI <connection-uri>` to use this option. 
-            |
-            | **Default**: ``mongodb``
+         - Specifies the service name of the `SRV resource records
+           <https://www.rfc-editor.org/rfc/rfc2782>`__ the driver retrieves to
+           construct your :manual:`seed list
+           </reference/glossary/#std-term-seed-list>`. You must use the
+           :manual:`DNS Seed List Connection Format
+           </reference/connection-string/#dns-seed-list-connection-format>` in
+           your :ref:`connection URI <connection-uri>` to use this option.  
+            
+           **Default**: ``mongodb``
 
   .. tab:: MongoClientSettings
     :tabid: MongoClient
@@ -126,7 +126,7 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
          - Sets all the specified locations of a Mongo deployment.
 
        * - ``localThreshold()``
-         - | Sets the amount of time that a server’s round trip can take and
+         - Sets the amount of time that a server’s round trip can take and
               still be eligible for server selection.
            | 
            | **Default**: ``15 milliseconds``
@@ -141,7 +141,7 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
          - Sets the replica set name required for the cluster.
 
        * - ``serverSelectionTimeout()``
-         - | Sets the maximum time to select a primary node before throwing a
+         - Sets the maximum time to select a primary node before throwing a
               timeout exception. 
            | 
            | **Default**: ``30 seconds``
@@ -150,7 +150,7 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
          - Adds a server selector to apply before server selection.
 
        * - ``srvHost()``
-         - | Sets the host name to use to look up an SRV DNS record to find the
+         - Sets the host name to use to look up an SRV DNS record to find the
               MongoDB hosts.  
            | 
            | If you want to enable the processing of TXT records associated
@@ -167,7 +167,7 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
                   .applyConnectionString(new ConnectionString("mongodb+srv://host1.acme.com")))
 
        * - ``srvMaxHosts()``
-         - | Sets the maximum number of hosts the driver can connect to when
+         - Sets the maximum number of hosts the driver can connect to when
               using the DNS seedlist (SRV) connection protocol, identified by
               the ``mongodb+srv`` connection string prefix.  
            | 
diff --git a/source/connection/specify-connection-options/configure-crud.txt b/source/connection/specify-connection-options/configure-crud.txt
@@ -13,6 +13,9 @@ Configure Client-level CRUD Settings
 .. facet::
    :name: genre
    :values: reference
+ 
+.. meta::
+   :keywords: retries
 
 Overview
 --------
@@ -43,7 +46,7 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
 
     .. list-table:: 
        :header-rows: 1 
-       :widths: 20 10 20
+       :widths: 25,25,50
 
        * - Option Name
          - Type
@@ -54,14 +57,14 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
          - | Specifies that the driver must wait for the connected MongoDB
              instance to group commit to the journal file on disk for all
              writes.  
-            |
-            | **Default**: ``false``
+           |
+           | **Default**: ``false``
 
        * - **w**
          - string or integer
          - | Specifies the write concern. For more information about values, see the server documentation for the :manual:`w option </reference/write-concern/#w-option>`.
-            |
-            | **Default**: ``1``
+           |
+           | **Default**: ``1``
 
        * - **wtimeoutMS**
          - integer
@@ -70,25 +73,25 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
              :manual:`wtimeoutMS option
              </reference/connection-string/#write-concern-options>`. A value of
              ``0`` instructs the driver to never time out write operations. 
-            |
-            | **Default**: ``0``
+           |
+           | **Default**: ``0``
 
        * - **readPreference**
          - string
          - | Specifies the read preference. For more information about values,
              see the server documentation for the :manual:`readPreference option
              </reference/connection-string/#urioption.readPreference>`. 
-            |
-            | **Default**: ``primary``
+           |
+           | **Default**: ``primary``
 
        * - **readPreferenceTags**
          - string
          - | Specifies the read preference tags. For more information about
              values, see the server documentation for the
              :manual:`readPreferenceTags option
              </reference/connection-string/#urioption.readPreferenceTags>`. 
-            |
-            | **Default**: ``null``
+           |
+           | **Default**: ``null``
 
        * - **maxStalenessSeconds**
          - integer
@@ -100,22 +103,81 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
              </reference/connection-string/#urioption.maxStalenessSeconds>`. Not
              providing a parameter or explicitly specifying ``-1`` indicates
              that there must be no staleness check for secondaries. 
-            |
-            | **Default**: ``-1``
+           |
+           | **Default**: ``-1``
 
        * - **uuidRepresentation**
          - string
          - | Specifies the UUID representation to use for read and write
              operations. For more information, see the driver documentation for
              the `MongoClientSettings.getUuidRepresentation() method
              <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html#getUuidRepresentation()>`__. 
-            |
-            | **Default**: ``unspecified``
+           |
+           | **Default**: ``unspecified``
+
+       * - **retryWrites**
+         - boolean
+         - | Specifies that the driver must retry supported write operations if
+             they are unable to complete due to a network error. 
+           |
+           | **Default**: ``true``
+
+       * - **retryReads**
+         - boolean
+         - | Specifies that the driver must retry supported read operations if
+             they are unable to complete due to a network error. 
+           |
+           | **Default**: ``true``
 
   .. tab:: MongoClientSettings
     :tabid: MongoClient
 
-    Chain the `readConcern() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#readConcern(com.mongodb.ReadConcern)>`__,
+    Chain the following methods to your ``MongoClientSettings``  constructor to modify the driver's read/write behavior:
+
+    .. list-table::
+       :header-rows: 1
+       :stub-columns: 1
+       :widths: 40 60
+
+       * - ``readConcern()``
+         - | Sets the read concern.
+           | - :manual:`Server manual page </reference/read-concern/>`
+           | - `API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#readConcern(com.mongodb.ReadConcern)>`__
+
+       * - ``readPreference()``
+         - | Sets the read preference.
+           | - :manual:`Server manual page </reference/read-preference/>`
+           | - `API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#readPreference(com.mongodb.ReadPreference)>`__
+           |
+           | **Default**: ``primary``
+
+       * - ``retryReads()``
+         - | Whether the driver performs :manual:`retry reads
+             </core/retryable-reads/>` if a network error occurs.
+           | - :manual:`Server manual page </core/retryable-reads/>`
+           |
+           | **Default**: ``true``
+
+       * - ``retryWrites()``
+         - | Whether the driver performs :manual:`retry writes
+             </core/retryable-writes/>` if a network error occurs. 
+           |
+           | **Default**: ``true``
+
+       * - ``uuidRepresentation()``
+         - Sets the UUID representation to use when encoding instances of UUID
+           and decoding BSON binary values with subtype of 3. 
+
+       * - ``writeConcern()``
+         - | Sets the :manual:`write concern </reference/write-concern/>`.
+           |
+           | **Default**: ``WriteConcern#ACKNOWLEDGED``. 
+           | For more information about the default value, see :manual:`Implicit Default Write Concern </reference/write-concern/#implicit-default-write-concern>`.  
+
+
+
+    `readConcern()
+    <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#readConcern(com.mongodb.ReadConcern)>`__,
     `readPreference()
     <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#readPreference(com.mongodb.ReadPreference)>`__,
     or `writeConcern()
diff --git a/source/connection/specify-connection-options/connection-options.txt b/source/connection/specify-connection-options/connection-options.txt
@@ -17,34 +17,6 @@ parameters of the connection URI to specify the behavior of the client.
      - Type
      - Description
 
-   * - **authMechanism**
-     - string
-     - Specifies the :ref:`authentication mechanism
-       <java-authentication-mechanisms>` that the driver uses if a credential
-       was supplied.
-
-       | **Default**: By default, the client picks the most secure
-         mechanism available based on the server version. For possible
-         values, see the server documentation for the
-         :manual:`authMechanism option
-         </reference/connection-string/#urioption.authMechanism>`.
-
-   * - **authSource**
-     - string
-     - Specifies the database in which the supplied credentials are validated. 
-
-       | **Default**: ``admin``
-
-   * - **authMechanismProperties**
-     - string
-     - Specifies authentication properties for the specified authentication
-       mechanism as a list of colon-separated properties and values.
-       For more information, see the server documentation for
-       the :manual:`authMechanismProperties option
-       </reference/connection-string/#urioption.authMechanismProperties>`.
-
-       | **Default**: ``null``
-
    * - **appName**
      - string
      - Specifies the name of the application provided to MongoDB instances
@@ -72,20 +44,6 @@ parameters of the connection URI to specify the behavior of the client.
 
        | **Default**: ``null``
 
-   * - **retryWrites**
-     - boolean
-     - Specifies that the driver must retry supported write operations
-       if they are unable to complete due to a network error.
-
-       | **Default**: ``true``
-
-   * - **retryReads**
-     - boolean
-     - Specifies that the driver must retry supported read operations
-       if they are unable to complete due to a network error.
-
-       | **Default**: ``true``
-
    * - **serverMonitoringMode**
      - string
      - Specifies which server monitoring protocol the driver uses. When set to
diff --git a/source/connection/specify-connection-options/mongoclientsettings.txt b/source/connection/specify-connection-options/mongoclientsettings.txt
@@ -102,43 +102,13 @@ connection behavior:
    * - ``credential()``
      - Sets the :ref:`credential <java-authentication-mechanisms>`.
 
-   * - ``readConcern()``
-     - Sets the :manual:`read concern </reference/read-concern/>`.
-
-   * - ``readPreference()``
-     - | Sets the :manual:`read preference </core/read-preference/>`.
-       |
-       | **Default**: ``primary``
-
-   * - ``retryReads()``
-     - | Whether the driver performs :manual:`retry reads </core/retryable-reads/>`
-         if a network error occurs.
-       |
-       | **Default**: ``true``
-
-   * - ``retryWrites()``
-     - | Whether the driver performs :manual:`retry writes </core/retryable-writes/>`
-         if a network error occurs.
-       |
-       | **Default**: ``true``
-
    * - ``serverApi()``
      - Sets the :ref:`server API <stable-api-java>` to use when sending
        commands to the server.
 
    * - ``transportSettings()``
      - Sets `TransportSettings <{+api+}/apidocs/mongodb-driver-core/com/mongodb/connection/TransportSettings.html>`__.
 
-   * - ``uuidRepresentation()``
-     - Sets the UUID representation to use when encoding instances of UUID
-       and decoding BSON binary values with subtype of 3.
-
-   * - ``writeConcern()``
-     - | Sets the :manual:`write concern </reference/write-concern/>`.
-       |
-       | **Default**: ``WriteConcern#ACKNOWLEDGED``. For more information about
-         the default value, see :manual:`Implicit Default Write Concern </reference/write-concern/#implicit-default-write-concern>`.
-
 .. _connection-string-example:
 
 Example
diff --git a/source/connection/specify-connection-options/socket-settings.txt b/source/connection/specify-connection-options/socket-settings.txt
diff --git a/source/security.txt b/source/security.txt
