Skip to content

Commit a66f569

Browse files
author
Chris Cho
authored
DOCSP-9027: Update documentation to reflect that NodeJS driver 4.0 requires Node 10 or later (#83)
* DOCSP-9027: update minimum node version to 8, add clarifications to FAQ entry
1 parent d546961 commit a66f569

File tree

4 files changed

+31
-16
lines changed

4 files changed

+31
-16
lines changed

source/faq.txt

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,28 @@ Frequently Asked Questions
1313
:class: singlecol
1414

1515

16-
What Is the Difference Between "connectTimeoutMS", "socketTimeoutMS" and "maxTimeMS" ?
17-
--------------------------------------------------------------------------------------------
16+
What Is the Difference Between "connectTimeoutMS", "socketTimeoutMS" and "maxTimeMS"?
17+
-------------------------------------------------------------------------------------
1818

1919
.. list-table::
2020
:header-rows: 1
2121

2222
* - Setting
23-
- Default Value
2423
- Description
2524
* - connectTimeoutMS
26-
- 30000
27-
- ``connectTimeoutMS`` is a `connection-setting <https://mongodb.github.io/node-mongodb-native/3.5/reference/connecting/connection-settings/>`_ option that sets the time in milliseconds to establish a connection to the MongoDB server before timing out.
25+
- | ``connectTimeoutMS`` is a :doc:`connection option </fundamentals/connection#connection-options>` that sets the time in milliseconds for an individual connection from your connection pool to establish a TCP connection to the MongoDB server before timing out. Use the ``serverSelectionTimeoutMS`` option instead to fail when :node-api:`MongoClient.connect <MongoClient.html#.connect>` is unable to establish a connection with the MongoDB server.
26+
|
27+
| **Default:** 30000
2828
* - socketTimeoutMS
29-
- 360000
30-
- ``socketTimeoutMS`` is a ``connection-settings`` option that sets the number of milliseconds a socket stays inactive after the driver has successfully connected before closing the connection.
29+
- ``socketTimeoutMS`` specifies the amount of time the driver waits
30+
for an inactive socket before closing it. The default value is to
31+
never time out the socket. This option applies only to sockets that
32+
have already been connected.
3133
* - maxTimeMS
32-
- N/A
33-
- :node-api:`maxTimeMS() </Cursor.html#maxTimeMS>` is a :manual:`cursor method </reference/method/js-cursor>` that specifies the max time limit for processing an operation on a cursor. If an operation runs over the time allotted it will return a timeout error.
34+
- :node-api:`maxTimeMS </Cursor.html#maxTimeMS>` is the maximum
35+
amount of time the server should wait for an operation to complete
36+
after it has reached the server. If an operation runs over the
37+
specified time limit, it returns a timeout error.
3438

3539
How Can I Prevent the Driver From Hanging During Connection or From Spending Too Long Trying to Reach Unreachable Replica Sets?
3640
-------------------------------------------------------------------------------------------------------------------------------
@@ -166,8 +170,8 @@ How Can I Prevent a Slow Operation From Delaying Other Operations?
166170
------------------------------------------------------------------
167171

168172
A slow operation may delay your other operations that occur after it, if
169-
the ``poolSize`` has not been set in the `connection settings
170-
<https://mongodb.github.io/node-mongodb-native/3.5/reference/connecting/connection-settings/>`_.
173+
the ``poolSize`` has not been set in the
174+
:doc:`Connection Options </fundamentals/connection#connection-options>`
171175
MongoDB is synchronous and uses a single execution thread per socket,
172176
meaning that MongoDB will execute one single operation per socket at any
173177
point in time. Any other operation sent to that socket will have to wait

source/includes/language-compatibility-table-node.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@
1313
- Node.js v0.10
1414
- Node.js v0.8
1515

16+
* - 4.0
17+
- ✓
18+
- ✓
19+
-
20+
-
21+
-
22+
-
23+
-
24+
-
25+
1626
* - 3.5
1727
- ✓
1828
- ✓

source/index.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ specify callbacks to access them when communicating with MongoDB.
2828

2929
.. note::
3030

31-
These docs are for version 3.5 of the MongoDB Node.js driver. If
31+
These docs are for version 4.0 of the MongoDB Node.js driver. If
3232
you are looking for an older version of the MongoDB Node.js driver
33-
docs, :node-docs:`see the Legacy Node.js driver documentation <>`.
33+
docs, `see the legacy Node.js driver documentation
34+
<http://mongodb.github.io/node-mongodb-native/>`_.
3435
For the main MongoDB documentation, see the :manual:`MongoDB Manual
3536
</>`.
3637

source/quick-start.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Set up Your Project
3131
Install Node and NPM
3232
~~~~~~~~~~~~~~~~~~~~
3333

34-
Ensure your system has Node.js version 8 or later and NPM (Node Package
35-
Manager) version 5 or later installed. For more information on how to check
36-
your version of Node and NPM and installation instructions for your
34+
Ensure your system has Node.js version 10 or later and a compatible
35+
version of NPM (Node Package Manager) installed. For more information on how
36+
to check your version of Node and NPM and installation instructions for your
3737
system, see `downloading and installing Node.js and npm
3838
<https://docs.npmjs.com/downloading-and-installing-node-js-and-npm>`_.
3939

0 commit comments

Comments
 (0)