16.20 - MonitorSessionRate - Teradata Vantage NewSQL Engine

Teradata Vantage™ Application Programming Reference

prodname
Teradata Database
Teradata Vantage NewSQL Engine
vrm_release
16.20
created_date
March 2019
category
Programming Reference
featnum
B035-1090-162K

Purpose

Returns session rate.

Definition

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

Input Parameters

Parameter Description
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.

An asterisk (*) indicates all users.

SessionNoIn Number of the specified session.

A value of zero indicates all sessions.

Usage Notes - MonitorSessionRate

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.

Return Value

This function returns the collection rate (that is, the duration of the collection period in seconds).

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