(DOCSP-20825) Connection Defaults (#213)

Author: biniona-mongodb

source/fundamentals/connection/connection-options.txt

@@ -21,51 +21,69 @@ parameters of the connection URI to specify the behavior of the client.
      - Specifies the minimum number of connections that must exist at
        any moment in a single connection pool.
 
+       | **Default**: ``0``
+
    * - **maxPoolSize**
      - integer
      - Specifies the maximum number of connections that a connection
        pool may have at a given time.
 
+       | **Default**: ``100``
+
    * - **waitQueueTimeoutMS**
      - integer
      - Specifies the maximum amount of time, in milliseconds that a
        thread may wait for a connection to become available.
 
+       | **Default**: ``120000`` (120 seconds)
+
    * - **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)
+
    * - **localThresholdMS**
      - integer
      - 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``
+
    * - **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)
+
    * - **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``
+
    * - **ssl**
      - boolean
      - Specifies that all communication with MongoDB instances should
        use TLS/SSL. Superseded by the **tls** option.
 
+       | **Default**: ``false``
+
    * - **tls**
      - boolean
      - Specifies that all communication with MongoDB instances should
        use TLS. Supersedes the **ssl** option.
 
+       | **Default**: ``false``
+
    * - **tlsInsecure**
      - boolean
      - Specifies that the driver should allow invalid hostnames for TLS
@@ -74,87 +92,122 @@ parameters of the connection URI to specify the behavior of the client.
        constraints in other ways, use a
        :ref:`custom SSLContext <tls-custom-sslContext>`.
 
+       | **Default**: ``false``
+
    * - **tlsAllowInvalidHostnames**
      - boolean
      - Specifies that the driver should allow invalid hostnames in the
        certificate for TLS connections. Supersedes
        **sslInvalidHostNameAllowed**.
 
+       | **Default**: ``false``
+
    * - **connectTimeoutMS**
      - integer
      - Specifies the maximum amount of time, in milliseconds, the Java
-       driver waits for a connection to open before timing out.
+       driver waits for a connection to open before timing out. A value of
+       ``0`` instructs the driver to never time out while waiting for a connection
+       to open.
+
+       | **Default**: ``10000`` (10 seconds)
 
    * - **socketTimeoutMS**
      - integer
      - Specifies the maximum amount of time, in milliseconds, the Java
        driver will wait to send or receive a request before timing out.
+       A value of ``0`` instructs the driver to never time out while waiting
+       to send or receive a request.
+
+       | **Default**: ``0``
 
    * - **maxIdleTimeMS**
      - integer
      - Specifies the maximum amount of time, in milliseconds, the Java
        driver will allow a pooled connection to idle before closing the
-       connection.
+       connection. A value of ``0`` indicates that there is no upper bound
+       on how long the driver can allow a pooled collection to be idle.
+
+       | **Default**: ``0``
 
    * - **maxLifeTimeMS**
      - integer
      - Specifies the maximum amount of time, in milliseconds, the Java
        driver will continue to use a pooled connection before closing the
-       connection.
+       connection. A value of ``0`` indicates that there is no upper bound
+       on how long the driver can keep a pooled connection open.
+
+       | **Default**: ``0``
 
    * - **journal**
      - boolean
      - 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``
+
    * - **w**
      - string or integer
      - Specifies the write concern. For more information on values, see
        the server documentation for the :manual:`w option
        </reference/write-concern/#w-option>`.
 
+       | **Default**: ``1``
+
    * - **wtimeoutMS**
      - integer
      - Specifies a time limit, in milliseconds, for the write concern. For
        more information, see the server documentation for 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``
 
    * - **readPreference**
      - string
      - Specifies the read preference. For more information on values, see
        the server documentation for the
        :manual:`readPreference option </reference/connection-string/#urioption.readPreference>`.
 
+       | **Default**: ``primary``
+
    * - **readPreferenceTags**
      - string
      - Specifies the read preference tags. For more information on values, see
        the server documentation for the
        :manual:`readPreferenceTags option </reference/connection-string/#urioption.readPreferenceTags>`.
 
+       | **Default**: ``null``
+
    * - **maxStalenessSeconds**
      - integer
      - Specifies, in seconds, how stale a secondary can be before the
-       driver stops communicating with that secondary. Not providing
-       a parameter or explicitly setting it to ``-1`` indicates that there
-       should be no staleness check for secondaries. The minimum value is
+       driver stops communicating with that secondary. The minimum value is
        either 90 seconds or the heartbeat frequency plus 10 seconds, whichever
        is greater. For more information, see the server documentation for the
        :manual:`maxStalenessSeconds option </reference/connection-string/#urioption.maxStalenessSeconds>`.
+       Not providing a parameter or explicitly specifying ``-1`` indicates
+       that there should be no staleness check for secondaries.
+
+       | **Default**: ``-1``
 
    * - **authMechanism**
      - string
      - Specifies the :doc:`authentication mechanism
        </fundamentals/auth>` that the driver should use if a credential
-       was supplied. 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>`.
+       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 that the supplied credentials should be
-       validated against. Defaults to ``admin``.
+       validated against. 
+       
+       | **Default**: ``admin``
 
    * - **authMechanismProperties**
      - string
@@ -164,19 +217,25 @@ parameters of the connection URI to specify the behavior of the client.
        the :manual:`authMechanismProperties option
        </reference/connection-string/#urioption.authMechanismProperties>`.
 
+       | **Default**: ``null``
+
    * - **appName**
      - string
      - Specifies the name of the application provided to MongoDB instances
        during the connection handshake. Can be used for server logs and
        profiling.
 
+       | **Default**: ``null``
+
    * - **compressors**
      - string
      - Specifies one or more compression algorithms that the driver
        will attempt to use to compress requests sent to the connected
        MongoDB instance. Possible values include: ``zlib``, ``snappy``,
        and ``zstd``.
 
+       | **Default**: ``null``
+
    * - **zlibCompressionLevel**
      - integer
      - Specifies the degree of compression that `Zlib <https://zlib.net/>`__
@@ -185,15 +244,22 @@ parameters of the connection URI to specify the behavior of the client.
        compressing faster (but resulting in larger requests) and larger values
        compressing slower (but resulting in smaller requests).
 
+       | **Default**: ``null``
+
    * - **retryWrites**
      - boolean
      - Specifies that the driver must retry supported write operations
-       if they fail due to a network error. Defaults to ``true``.
+       if they fail due to a network error.
+
+       | **Default**: ``true``
+
 
    * - **retryReads**
      - boolean
      - Specifies that the driver must retry supported read operations
-       if they fail due to a network error. Defaults to ``true``.
+       if they fail due to a network error.
+
+       | **Default**: ``true``
 
    * - **uuidRepresentation**
      - string
@@ -202,14 +268,20 @@ parameters of the connection URI to specify the behavior of the client.
        for the
        `MongoClientSettings.getUuidRepresentation() method <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html#getUuidRepresentation()>`__.
 
+       | **Default**: ``unspecified``
+
    * - **directConnection**
      - boolean
      - Specifies that the driver must connect to the host directly.
 
+       | **Default**: ``false``
+
    * - **maxConnecting**
      - integer
      - Specifies the maximum number of connections a pool may be establishing
-       concurrently. Defaults to ``2``.
+       concurrently.
+       
+       | **Default**: ``2``
 
    * - **srvServiceName**
      - string
@@ -221,8 +293,9 @@ parameters of the connection URI to specify the behavior of the client.
        :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. Defaults to ``"mongodb"``.
-
+       to use this option. 
+       
+       | **Default**: ``mongodb``
 
 For a complete list of options, see the
 `ConnectionString <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ConnectionString.html>`__