@@ -12,8 +12,11 @@ Connection Options
12
12
:keywords: node.js, customize
13
13
14
14
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.
17
20
18
21
.. list-table::
19
22
:header-rows: 1
@@ -100,12 +103,6 @@ parameters of the connection URI to specify the behavior of the client.
100
103
- ``null``
101
104
- Specifies the interval, in milliseconds, between regular server monitoring checks.
102
105
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
-
109
106
* - **loadBalanced**
110
107
- boolean
111
108
- ``null``
@@ -230,12 +227,6 @@ parameters of the connection URI to specify the behavior of the client.
230
227
- Specifies the timeout, in milliseconds, to block for server selection
231
228
before raising an error.
232
229
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
-
239
230
* - **socketTimeoutMS**
240
231
- non-negative integer
241
232
- ``0``
@@ -311,22 +302,12 @@ parameters of the connection URI to specify the behavior of the client.
311
302
allowing invalid certificates or hostname mismatches. Set this option
312
303
to ``true`` for testing purposes only.
313
304
314
- * - **w**
315
- - non-negative integer or string
316
- - ``null``
317
- - Specifies the default write concern ``"w"`` field for the client.
318
-
319
305
* - **waitQueueTimeoutMS**
320
306
- non-negative integer
321
307
- ``0``
322
308
- Specifies the amount of time, in milliseconds, spent attempting to check out a connection
323
309
from a server's connection pool before timing out.
324
310
325
- * - **wTimeoutMS**
326
- - non-negative integer
327
- - ``null``
328
- - Specifies the default write concern timeout field for the client.
329
-
330
311
* - **zlibCompressionLevel**
331
312
- integer between ``-1`` and ``9`` (inclusive)
332
313
- ``-1``
@@ -335,3 +316,9 @@ parameters of the connection URI to specify the behavior of the client.
335
316
no compression, ``1`` signifies the fastest speed, and ``9`` signifies
336
317
the best compression. See :ref:`node-network-compression` for more information.
337
318
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