Skip to content

Commit

Permalink
DOCSP-31359 Revise Connection Options (#941)
Browse files Browse the repository at this point in the history
* DOCSP-31359 Revise Connection Options

* better intro

* add an a

* Michael's review comments
  • Loading branch information
lindseymoore authored Dec 3, 2024
1 parent d3cdc74 commit 1a352c0
Showing 1 changed file with 11 additions and 24 deletions.
35 changes: 11 additions & 24 deletions source/fundamentals/connection/connection-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ Connection Options
:keywords: node.js, customize

This section explains the MongoDB connection and authentication options
supported by the driver. You can pass the connection options as
parameters of the connection URI to specify the behavior of the client.
supported by the {+driver-short+} that you can set within a ``MongoClientOptions`` instance.

For more information on setting connection options directly in a connection
string, see :manual:`Connection Strings </reference/connection-string/>` in the
{+mdb-server+} manual.

.. list-table::
:header-rows: 1
Expand Down Expand Up @@ -100,12 +103,6 @@ parameters of the connection URI to specify the behavior of the client.
- ``null``
- Specifies the interval, in milliseconds, between regular server monitoring checks.

* - **journal**
- boolean
- ``null``
- Specifies the journal write concern for the client. See
:ref:`write concern <wc-j>` for more information.

* - **loadBalanced**
- boolean
- ``null``
Expand Down Expand Up @@ -230,12 +227,6 @@ parameters of the connection URI to specify the behavior of the client.
- Specifies the timeout, in milliseconds, to block for server selection
before raising an error.

* - **serverSelectionTryOnce**
- boolean
- ``true``
- Specifies to scan the topology only once after a server selection
failure instead of repeatedly until the server selection times out.

* - **socketTimeoutMS**
- non-negative integer
- ``0``
Expand Down Expand Up @@ -311,22 +302,12 @@ parameters of the connection URI to specify the behavior of the client.
allowing invalid certificates or hostname mismatches. Set this option
to ``true`` for testing purposes only.

* - **w**
- non-negative integer or string
- ``null``
- Specifies the default write concern ``"w"`` field for the client.

* - **waitQueueTimeoutMS**
- non-negative integer
- ``0``
- Specifies the amount of time, in milliseconds, spent attempting to check out a connection
from a server's connection pool before timing out.

* - **wTimeoutMS**
- non-negative integer
- ``null``
- Specifies the default write concern timeout field for the client.

* - **zlibCompressionLevel**
- integer between ``-1`` and ``9`` (inclusive)
- ``-1``
Expand All @@ -335,3 +316,9 @@ parameters of the connection URI to specify the behavior of the client.
no compression, ``1`` signifies the fastest speed, and ``9`` signifies
the best compression. See :ref:`node-network-compression` for more information.

Additional Information
----------------------

To learn more about connection options that you can set within a
``MongoClientOptions`` instance, see `MongoClientOptions <{+api+}/interfaces/MongoClientOptions.html>`__
in the API Documentation.

0 comments on commit 1a352c0

Please sign in to comment.