Skip to content

DOCSP-40094: Clarify MongoClient.close() behavior #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 2, 2024
Merged

DOCSP-40094: Clarify MongoClient.close() behavior #898

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a98618e
DOCSP-40094: Clarify MongoClient.close() behavior
norareidy Aug 1, 2024
c725ff3
RR feedback
norareidy Aug 1, 2024
9717a6c
RR feedback 2
norareidy Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions source/faq.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


The ``MongoClient.close()`` method closes existing sessions and
transactions, which might indirectly affect the behavior of ongoing
operations and open cursors.

What Is the Difference Between "connectTimeoutMS", "socketTimeoutMS" and "maxTimeMS"?
-------------------------------------------------------------------------------------

Expand Down
Loading