DOCSP-40094: Clarify MongoClient.close() behavior #898
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustagir
requested changes
Aug 1, 2024
source/faq.txt
Outdated
| @@ -106,6 +106,12 @@ closes only inactive sockets, so you cannot interrupt or terminate | |||
| any ongoing operations by using this method. The driver closes these | |||
| sockets only when the process completes. | |||
|
|
|||
| .. note:: | |||
There was a problem hiding this comment.
S: I think you should clip the last few sentences from the preceding paragraph and combine them into this note. Right now, the paragraph says
Calling MongoClient.close() closes only inactive sockets, so you cannot interrupt or terminate any ongoing operations by using this method. The driver closes these sockets only when the process completes.
But then this note contradicts that point. Maybe the combined content could express the following points:
- Calling MongoClient.close() closes only inactive sockets
- It also closes existing sessions and txns
- So, even though you might not impact operations by closing a socket, you might impact an operation occurring in a transaction
rustagir
reviewed
Aug 2, 2024
source/faq.txt
Outdated
| closes only inactive sockets, so you cannot interrupt or terminate | ||
| any ongoing operations by using this method. The driver closes these | ||
| sockets only when the process completes. | ||
| closes only inactive sockets and does not actively terminate |
There was a problem hiding this comment.
Suggested change
| closes only inactive sockets and does not actively terminate | |
| closes only inactive sockets and does not directly terminate |
source/faq.txt
Outdated
Comment on lines
106
to
107
| any ongoing operations. The driver closes in-use sockets only when | ||
| the operation completes. However, the ``MongoClient.close()`` method |
There was a problem hiding this comment.
Suggested change
| any ongoing operations. The driver closes in-use sockets only when | |
| the operation completes. However, the ``MongoClient.close()`` method | |
| any ongoing operations. The driver closes any in-use sockets only when | |
| the associated operations complete. However, the ``MongoClient.close()`` method |
rustagir
approved these changes
Aug 2, 2024
norareidy
added a commit
that referenced
this pull request
Aug 2, 2024
* DOCSP-40094: Clarify MongoClient.close() behavior * RR feedback * RR feedback 2 (cherry picked from commit b9bccea)
norareidy
added a commit
that referenced
this pull request
Aug 2, 2024
* DOCSP-40094: Clarify MongoClient.close() behavior * RR feedback * RR feedback 2 (cherry picked from commit b9bccea)
norareidy
added a commit
that referenced
this pull request
Aug 2, 2024
* DOCSP-40094: Clarify MongoClient.close() behavior * RR feedback * RR feedback 2 (cherry picked from commit b9bccea)
norareidy
added a commit
that referenced
this pull request
Aug 2, 2024
* DOCSP-40094: Clarify MongoClient.close() behavior * RR feedback * RR feedback 2 (cherry picked from commit b9bccea)
norareidy
added a commit
that referenced
this pull request
Aug 2, 2024
* DOCSP-40094: Clarify MongoClient.close() behavior * RR feedback * RR feedback 2 (cherry picked from commit b9bccea)
norareidy
added a commit
that referenced
this pull request
Aug 2, 2024
* DOCSP-40094: Clarify MongoClient.close() behavior * RR feedback * RR feedback 2 (cherry picked from commit b9bccea)
norareidy
added a commit
that referenced
this pull request
Aug 2, 2024
* DOCSP-40094: Clarify MongoClient.close() behavior * RR feedback * RR feedback 2 (cherry picked from commit b9bccea)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-40094
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/node/DOCSP-40094-close-behavior/faq/#how-does-connection-pooling-work-in-the-node-driver-
Self-Review Checklist