Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 3.27 KB

cancel-session.md

File metadata and controls

93 lines (70 loc) · 3.27 KB
title summary toc
CANCEL SESSION
The CANCEL SESSION statement stops long-running sessions.
true

The CANCEL SESSION statement lets you stop long-running sessions. CANCEL SESSION will attempt to cancel the currently active query and end the session.

Required privileges

Only members of the admin role and the user that the session belongs to can cancel a session. By default, the root user belongs to the admin role.

Synopsis

{% include {{ page.version.version }}/sql/diagrams/cancel_session.html %}

Parameters

Parameter Description
session_id The ID of the session you want to cancel, which can be found with SHOW SESSIONS.

CANCEL SESSION accepts a single session ID. If a subquery is used and returns multiple IDs, the CANCEL SESSION statement will fail. To cancel multiple sessions, use CANCEL SESSIONS.
select_stmt A selection query that returns session_id(s) to cancel.

Example

Cancel a single session

In this example, we use the SHOW SESSIONS statement to get the ID of a session and then pass the ID into the CANCEL SESSION statement:

{% include copy-clipboard.html %}

> SHOW SESSIONS;
+---------+----------------------------------+-----------+...
| node_id |            session_id            | user_name |...
+---------+----------------------------------+-----------+...
|       1 | 1530c309b1d8d5f00000000000000001 | root      |...
+---------+----------------------------------+-----------+...
|       1 | 1530fe0e46d2692e0000000000000001 | maxroach  |...
+---------+----------------------------------+-----------+...

{% include copy-clipboard.html %}

> CANCEL SESSION '1530fe0e46d2692e0000000000000001';

You can also cancel a session using a subquery that returns a single session ID:

{% include copy-clipboard.html %}

> CANCEL SESSIONS (SELECT session_id FROM [SHOW SESSIONS]
      WHERE username = 'root');

Cancel multiple sessions

Use the SHOW SESSIONS statement to view all active sessions:

{% include copy-clipboard.html %}

> SHOW SESSIONS;
+---------+----------------------------------+-----------+...
| node_id |            session_id            | user_name |...
+---------+----------------------------------+-----------+...
|       1 | 1530c309b1d8d5f00000000000000001 | root      |...
+---------+----------------------------------+-----------+...
|       1 | 1530fe0e46d2692e0000000000000001 | maxroach  |...
+---------+----------------------------------+-----------+...
|       1 | 15310cc79671fc6a0000000000000001 | maxroach  |...
+---------+----------------------------------+-----------+...

To cancel multiple sessions, nest a SELECT clause that retrieves session_id(s) inside the CANCEL SESSIONS statement:

{% include copy-clipboard.html %}

> CANCEL SESSIONS (SELECT session_id FROM [SHOW SESSIONS]
      WHERE user_name = 'maxroach');

All sessions created by maxroach will be cancelled.

See also