DOCSP-40099: Add note about client.connect() #894
Conversation
| @@ -95,6 +95,14 @@ verify that the connection is successful: | |||
| .. literalinclude:: /code-snippets/connection/stable-api-connect.js | |||
| :language: javascript | |||
|
|
|||
| .. note:: | |||
|
|
|||
| As of v4.7, the {+driver-short+} will automatically call the ``MongoClient.connect()`` | |||
There was a problem hiding this comment.
S: specify driver version (as opposed to server version)
| As of v4.7, the {+driver-short+} will automatically call the ``MongoClient.connect()`` | |
| As of {+driver-short+} v4.7, the driver will automatically call the ``MongoClient.connect()`` |
| @@ -95,6 +95,14 @@ verify that the connection is successful: | |||
| .. literalinclude:: /code-snippets/connection/stable-api-connect.js | |||
| :language: javascript | |||
|
|
|||
| .. note:: | |||
|
|
|||
| As of v4.7, the {+driver-short+} will automatically call the ``MongoClient.connect()`` | |||
There was a problem hiding this comment.
I: present tense
| As of v4.7, the {+driver-short+} will automatically call the ``MongoClient.connect()`` | |
| As of v4.7, the {+driver-short+} automatically calls the ``MongoClient.connect()`` |
| .. note:: | ||
|
|
||
| As of v4.7, the {+driver-short+} will automatically call the ``MongoClient.connect()`` | ||
| method when using the client to interact with your MongoDB instance, **except** when |
There was a problem hiding this comment.
I: the prerequisite of "using the client to interact with..." isn't clear to me. what does the user have to do to get the driver to call this automatically?
| .. note:: | ||
|
|
||
| As of v4.7, the {+driver-short+} will automatically call the ``MongoClient.connect()`` | ||
| method when using the client to interact with your MongoDB instance, **except** when |
There was a problem hiding this comment.
I: there was a whole thing about a year ago about server vs. deployment vs. instance. i think the upshot was:
- MongoDB Server = the product
- MongoDB deployment = a running instance of MongoDB
- MongoDB instance = not preferred
| method when using the client to interact with your MongoDB instance, **except** when | |
| method when using the client to interact with your MongoDB deployment, **except** when |
| .. note:: | ||
|
|
||
| As of v4.7, the {+driver-short+} will automatically call the ``MongoClient.connect()`` | ||
| method when using the client to interact with your MongoDB instance, **except** when |
There was a problem hiding this comment.
S: the sentence is a little long, and the "except" clause seems pretty important. better as its own sentence?
| you use the client to call bulk operations. We recommend manually calling | ||
| ``MongoClient.connect()`` if you want granular control and insight over | ||
| your application's connections. |
There was a problem hiding this comment.
S: i think it would be useful to be more specific here; "granular control and insight" is correct, but might not be helpful to a newer user. (you could also add info about bulk writes here)
| you use the client to call bulk operations. We recommend manually calling | |
| ``MongoClient.connect()`` if you want granular control and insight over | |
| your application's connections. | |
| you use the client to call bulk operations. Call the ``MongoClient.connect()`` method | |
| explicitly if you are performing bulk operations or if you want to verify that the | |
| connection was successful. |
| method when using the client to perform CRUD operations on your MongoDB deployment. | ||
| Call the ``MongoClient.connect()`` method explicitly to verify that the connection is | ||
| successful. | ||
|
|
There was a problem hiding this comment.
@nbbeeken in the #node-driver-docs Slack channel posted proof that this automatic connection still works with bulk ops.
"Call the MongoClient.connect() method explicitly if you would like to verify that the connection is successful" as per @mongoKart's suggestion gets flagged by Vale for the italicized portion.
There was a problem hiding this comment.
How about: "...if you want to manually verify that the connection..."? As worded, it sounds like we're directing users to do it, which isn't necessary.
| method when using the client to perform CRUD operations on your MongoDB deployment. | ||
| Call the ``MongoClient.connect()`` method explicitly to verify that the connection is | ||
| successful. | ||
|
|
There was a problem hiding this comment.
How about: "...if you want to manually verify that the connection..."? As worded, it sounds like we're directing users to do it, which isn't necessary.
| you use the client to call bulk operations. We recommend manually calling | ||
| ``MongoClient.connect()`` if you want granular control and insight over | ||
| your application's connections. | ||
| As of {+driver-short+} v4.7, the driver automatically calls the ``MongoClient.connect()`` |
There was a problem hiding this comment.
S: this is presumably getting backported to all active docs versions, and v4.7 is in legacy. Do we need to say when this behavior started?
| As of {+driver-short+} v4.7, the driver automatically calls the ``MongoClient.connect()`` | |
| The {+driver-short+} automatically calls the ``MongoClient.connect()`` |
There was a problem hiding this comment.
Well spotted, happy to remove.
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
(cherry picked from commit 6ab9caa)
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-40099
Staging - https://preview-mongodbmcmorisi.gatsbyjs.io/node/DOCSP-40099-client-connect/fundamentals/connection/connect/#atlas-connection-example
Self-Review Checklist