AbortSessions Syntax - Teradata VantageCloud Lake

REPLACE FUNCTION SYSLIB.AbortSessions (
  HostIdIn SMALLINT,
  UserNameIn TD_ANYTYPE,
  SessionNoIn INTEGER,
  LogoffSessions VARCHAR(1) CHARACTER SET LATIN,
  UserOverride VARCHAR(1) CHARACTER SET LATIN
) RETURNS INTEGER
  ... 
;

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 after aborting them:

• Y = Log off and end 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 running 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.