From 1c104783a268c14f13e8e754f420de92eb05f8b0 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 2 Dec 2024 16:29:13 -0500 Subject: [PATCH 1/4] DOCSP-31359 Revise Connection Options --- .../fundamentals/connection/connection-options.txt | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/source/fundamentals/connection/connection-options.txt b/source/fundamentals/connection/connection-options.txt index 86c7db6d4..f3ef529ee 100644 --- a/source/fundamentals/connection/connection-options.txt +++ b/source/fundamentals/connection/connection-options.txt @@ -100,12 +100,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 ` for more information. - * - **loadBalanced** - boolean - ``null`` @@ -322,10 +316,10 @@ parameters of the connection URI to specify the behavior of the client. - 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. + * - ** ** + - dd + - dd + - * - **zlibCompressionLevel** - integer between ``-1`` and ``9`` (inclusive) From 6862ce844eeddee474a44494b07c40f305729521 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 2 Dec 2024 17:18:49 -0500 Subject: [PATCH 2/4] better intro --- .../connection/connection-options.txt | 29 +++++++------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/source/fundamentals/connection/connection-options.txt b/source/fundamentals/connection/connection-options.txt index f3ef529ee..2fbc5ce6c 100644 --- a/source/fundamentals/connection/connection-options.txt +++ b/source/fundamentals/connection/connection-options.txt @@ -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 that you can set within a ``MongoClientOptions`` instance. + +For more information on setting connection options directly in a connection +string, see :manual:`Connection Strings ` in the +Server manual. .. list-table:: :header-rows: 1 @@ -224,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`` @@ -305,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. - * - ** ** - - dd - - dd - - - * - **zlibCompressionLevel** - integer between ``-1`` and ``9`` (inclusive) - ``-1`` @@ -329,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 +---------------------- + +For more complete information on connection options that you can set within the +``MongoClientOptions`` instance, see `MongoClientOptions <{+api+}/interfaces/MongoClientOptions.html>`__ +in the API Documentation. From 78dd5f8e6afd1fb23b6a93c1d5dad9ade913822c Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 2 Dec 2024 17:55:19 -0500 Subject: [PATCH 3/4] add an a --- source/fundamentals/connection/connection-options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/fundamentals/connection/connection-options.txt b/source/fundamentals/connection/connection-options.txt index 2fbc5ce6c..4441c7870 100644 --- a/source/fundamentals/connection/connection-options.txt +++ b/source/fundamentals/connection/connection-options.txt @@ -319,6 +319,6 @@ Server manual. Additional Information ---------------------- -For more complete information on connection options that you can set within the +For more complete information on connection options that you can set within a ``MongoClientOptions`` instance, see `MongoClientOptions <{+api+}/interfaces/MongoClientOptions.html>`__ in the API Documentation. From 0f10151d99c8851cadf589b3c99dd57c68696c29 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Tue, 3 Dec 2024 13:39:52 -0500 Subject: [PATCH 4/4] Michael's review comments --- source/fundamentals/connection/connection-options.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/fundamentals/connection/connection-options.txt b/source/fundamentals/connection/connection-options.txt index 4441c7870..90f218fec 100644 --- a/source/fundamentals/connection/connection-options.txt +++ b/source/fundamentals/connection/connection-options.txt @@ -12,11 +12,11 @@ Connection Options :keywords: node.js, customize This section explains the MongoDB connection and authentication options -supported by the driver that you can set within a ``MongoClientOptions`` instance. +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 ` in the -Server manual. +{+mdb-server+} manual. .. list-table:: :header-rows: 1 @@ -319,6 +319,6 @@ Server manual. Additional Information ---------------------- -For more complete information on connection options that you can set within a +To learn more about connection options that you can set within a ``MongoClientOptions`` instance, see `MongoClientOptions <{+api+}/interfaces/MongoClientOptions.html>`__ in the API Documentation.