onmode and z arguments: Terminate a user session (SQL administration API)

Use the onmode and z arguments with the admin() or task() function to terminate the specified user session.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-EXECUTE FUNCTION--+-admin-+--(------------------------------->
                     '-task--'      

>--"onmode"--,--"z"--,--"session_id"--)--;---------------------><

Element Description Key Considerations
session_id The session ID. The value must be an unsigned integer greater than 0, and must be the session identification number of a currently running session.

Usage

This function is equivalent to the onmode -z command.

Example

The following example terminates the user session with an ID of 14:
EXECUTE FUNCTION task("onmode","z","14");

Copyright© 2018 HCL Technologies Limited