Skip to content

Clarify what killing a session means. #3254

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.

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 1 commit into from
Sep 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions source/includes/note-killSessions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. note::

Killing a session kills any in-progress operations in the
session, and closes any open cursors associated with these
operations. The killed session may still be listed as a
current session, and future operations may use the killed
session.
2 changes: 2 additions & 0 deletions source/reference/command/killAllSessions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Definition
The :dbcommand:`killAllSessions` command kills all sessions for the
specified users.

.. include:: /includes/note-killSessions.rst

.. code-block:: javascript

{ killAllSessions: [ { user: <user>, db: <dbname> }, ... ] }
Expand Down
2 changes: 2 additions & 0 deletions source/reference/command/killAllSessionsByPattern.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Definition
The :dbcommand:`killAllSessionsByPattern` command kills all sessions
that match any of the specified patterns:

.. include:: /includes/note-killSessions.rst

.. code-block:: javascript

{ killAllSessionsByPattern: [ <pattern>, ... ] }
Expand Down
6 changes: 1 addition & 5 deletions source/reference/command/killSessions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,7 @@ Definition
If access control is enabled, the command only kills the sessions
owned by the user.

.. note::

Killing a session also kills any in-progress operations in the
session and closes any open cursors associated with these
operations.
.. include:: /includes/note-killSessions.rst

:dbcommand:`killSessions` has the following syntax:

Expand Down