AbortListSessions Function | Application Programming Reference | Vantage - 17.10 - AbortListSessions - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - Application Programming Reference

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1090-171K
Language
English (United States)

Aborts the session and lists the status of the aborted sessions.

Syntax

REPLACE FUNCTION SYSLIB.AbortListSessions (
  HostIdIn SMALLINT,
  UserNameIn TD_ANYTYPE,
  SessionNoIn INTEGER,
  LogoffSessions VARCHAR(1) CHARACTER SET LATIN,
  UserOverride VARCHAR(1) CHARACTER SET LATIN
) RETURNS TABLE (
    HostId SMALLINT,
    SessionNo INTEGER,
    UserName VARCHAR(128) CHARACTER SET UNICODE,
    AbortStatus CHAR CHARACTER SET LATIN
  )
  ... 
;

Syntax Elements

HostIdIn
Logical ID of a host (or client) with sessions logged on. A value of -1 indicates all hosts.
UserNameIn
User name of the session. An asterisk (*) or NULL indicates all users.
SessionNoIn
ID of the session to abort. A value of zero indicates all sessions.
LogoffSessions
Indicator of whether to log off sessions to Vantage in addition to aborting them:
  • Y = Log off and abort sessions.
  • N or NULL = Do not log sessions off.
UserOverride
Indicator of whether to override an ABORT SESSION failure:
  • Y = Override the ABORT SESSION request to fail in any of the following cases:
    • An identified session is being session-switched.
    • An identified session is executing its own ABORT SESSION request.
    • An identified session has a PEState of IDLE: IN-DOUBT as a result of a 2PC.

      Sessions are marked IN-DOUBT by the 2PC protocol, which governs how transactions are committed by multiple systems that do not share memory. The protocol guarantees that either all systems commit or all roll back.

  • N or NULL = Do not override.
HostId
Logical host ID of (or client) the aborted sessions were logged on to. For a PE, HostId identifies one of the hosts or LANs associated with the described PE. For a session, the combination of a host ID and a session number uniquely identifies a user session on the system.
This value is NULL for AMPs. A value of zero represents the Supervisor window.
SessionNo
Number of the session that was aborted. Together with a given host ID, a session number uniquely identifies a session on the Teradata system. This value is assigned by the host (or client) at logon time.
UserName
User name of the session that was aborted.
AbortStatus
Status of the sessions aborted:
  • I = In-Doubt
  • A = Aborting a transaction
  • C = Committing a transaction
  • E = Executing an ABORT SESSION request
  • S = Switching
  • An empty string = In some state other than the above. This value returns when issuing an SQL function.
For an ABORT without LOGOFF, any status except NULL indicates the reason the request could not impact the associated session.
For an ABORT with LOGOFF, an I, E, or S status value indicates that the associated session cannot be aborted or logged off.

Usage Notes

This table function is only supported in Constant Mode.

AbortListSessions cannot be used to abort delayed utility sessions because these sessions are not completely logged on.

This function provides similar functionality to the PMPC ABORT SESSION request with ListSessions set to ‘N’ or ‘No’.

Example: Using AbortListSessions

SELECT * FROM TABLE (AbortListSessions(1, 'User14', 0, 'Y', 'Y')) AS t1;
 *** Query completed. 5 rows found. 4 columns returned.
 *** Total elapsed time was 4 seconds.
HostId    SessionNo  UserName    AbortStatus
------  -----------  ----------- -----------
     1         1007  USER14
     1         1011  USER14
     1         1010  USER14
     1         1009  USER14
     1         1008  USER14