MonitorSessionRate Function | Application Programming Reference | Vantage - 17.10 - MonitorSessionRate - 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)

Returns session rate (duration of the collection period in seconds).

Syntax

REPLACE FUNCTION SYSLIB.MonitorSessionRate (
  HostIdIn SMALLINT,
  UserNameIn TD_ANYTYPE,
  SessionNoIn INTEGER
) RETURNS SMALLINT
  ...
;

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 specified sessions.
A value of -1 indicates all hosts.
SessionNoIn
Number of the specified session.
A value of zero indicates all sessions.

Usage Notes

Before you monitor the collection rate, you use the SetSessionRate function to set the collection rate for updating session-level statistics in memory.

The MonitorSessionRate function provides similar functionality to the PMPC Monitor Session request. For information about this interface, see MONITOR SESSION.

Example: Using MonitorSessionRate

SELECT MonitorSessionRate(1,'*',0);
 *** Query completed. One row found. One column returned.
 *** Total elapsed time was 7 seconds.
MonitorSessionRate(1, '*', 0)
-----------------------------
                          60