From da879231f29838c086dded53e24729807cc66de4 Mon Sep 17 00:00:00 2001 From: Kevin Pulo Date: Fri, 2 Mar 2018 17:06:40 +1100 Subject: [PATCH] Clarify what killing a session means. --- source/includes/note-killSessions.rst | 7 +++++++ source/reference/command/killAllSessions.txt | 2 ++ source/reference/command/killAllSessionsByPattern.txt | 2 ++ source/reference/command/killSessions.txt | 6 +----- 4 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 source/includes/note-killSessions.rst diff --git a/source/includes/note-killSessions.rst b/source/includes/note-killSessions.rst new file mode 100644 index 00000000000..63b8e08fb7a --- /dev/null +++ b/source/includes/note-killSessions.rst @@ -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. diff --git a/source/reference/command/killAllSessions.txt b/source/reference/command/killAllSessions.txt index 17bbeb2bb4c..228421fab90 100644 --- a/source/reference/command/killAllSessions.txt +++ b/source/reference/command/killAllSessions.txt @@ -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: , db: }, ... ] } diff --git a/source/reference/command/killAllSessionsByPattern.txt b/source/reference/command/killAllSessionsByPattern.txt index 936e7b53dc2..4edc24d132f 100644 --- a/source/reference/command/killAllSessionsByPattern.txt +++ b/source/reference/command/killAllSessionsByPattern.txt @@ -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: [ , ... ] } diff --git a/source/reference/command/killSessions.txt b/source/reference/command/killSessions.txt index 0648761f196..a8fe2b4f5ad 100644 --- a/source/reference/command/killSessions.txt +++ b/source/reference/command/killSessions.txt @@ -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: