Skip to content

Commit 1a352c0

Browse files
authored
DOCSP-31359 Revise Connection Options (#941)
* DOCSP-31359 Revise Connection Options * better intro * add an a * Michael's review comments
1 parent d3cdc74 commit 1a352c0

File tree

1 file changed

+11
-24
lines changed

1 file changed

+11
-24
lines changed

source/fundamentals/connection/connection-options.txt

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ Connection Options
1212
:keywords: node.js, customize
1313

1414
This section explains the MongoDB connection and authentication options
15-
supported by the driver. You can pass the connection options as
16-
parameters of the connection URI to specify the behavior of the client.
15+
supported by the {+driver-short+} that you can set within a ``MongoClientOptions`` instance.
16+
17+
For more information on setting connection options directly in a connection
18+
string, see :manual:`Connection Strings </reference/connection-string/>` in the
19+
{+mdb-server+} manual.
1720

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

103-
* - **journal**
104-
- boolean
105-
- ``null``
106-
- Specifies the journal write concern for the client. See
107-
:ref:`write concern <wc-j>` for more information.
108-
109106
* - **loadBalanced**
110107
- boolean
111108
- ``null``
@@ -230,12 +227,6 @@ parameters of the connection URI to specify the behavior of the client.
230227
- Specifies the timeout, in milliseconds, to block for server selection
231228
before raising an error.
232229

233-
* - **serverSelectionTryOnce**
234-
- boolean
235-
- ``true``
236-
- Specifies to scan the topology only once after a server selection
237-
failure instead of repeatedly until the server selection times out.
238-
239230
* - **socketTimeoutMS**
240231
- non-negative integer
241232
- ``0``
@@ -311,22 +302,12 @@ parameters of the connection URI to specify the behavior of the client.
311302
allowing invalid certificates or hostname mismatches. Set this option
312303
to ``true`` for testing purposes only.
313304

314-
* - **w**
315-
- non-negative integer or string
316-
- ``null``
317-
- Specifies the default write concern ``"w"`` field for the client.
318-
319305
* - **waitQueueTimeoutMS**
320306
- non-negative integer
321307
- ``0``
322308
- Specifies the amount of time, in milliseconds, spent attempting to check out a connection
323309
from a server's connection pool before timing out.
324310

325-
* - **wTimeoutMS**
326-
- non-negative integer
327-
- ``null``
328-
- Specifies the default write concern timeout field for the client.
329-
330311
* - **zlibCompressionLevel**
331312
- integer between ``-1`` and ``9`` (inclusive)
332313
- ``-1``
@@ -335,3 +316,9 @@ parameters of the connection URI to specify the behavior of the client.
335316
no compression, ``1`` signifies the fastest speed, and ``9`` signifies
336317
the best compression. See :ref:`node-network-compression` for more information.
337318

319+
Additional Information
320+
----------------------
321+
322+
To learn more about connection options that you can set within a
323+
``MongoClientOptions`` instance, see `MongoClientOptions <{+api+}/interfaces/MongoClientOptions.html>`__
324+
in the API Documentation.

0 commit comments

Comments
 (0)