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

Sets the global rates for updating session-level statistics in memory.

This function returns the previous collection rate value in seconds.

Syntax

REPLACE FUNCTION SetSessionRate (
  SampleRate INTEGER
) RETURNS INTEGER
  ...
;

Syntax Elements

SampleRate
Sets the global rate. The value ranges from 1 to 3600 seconds. If the rate is set to zero an error is reported.
The collection rate applies to global queries.

Usage Notes

There is no option equivalent to the PMPC SET SESSION RATE request Local_Change = Y option because when using the SetSessionRate function, there is no local MONITOR PARTITION in which to apply the rate to.

You can set the SetSessionRate function to a global (SesMonitorSys) rate. That is, a collection rate at which session-level statistics are collected in memory. This rate is returned in the SesMonitorSys data value by the MonitorVirtualSummary function.

The SetSessionRate function provides similar functionality to the PMPC SET SESSION RATE request. For information about this interface, see SET SESSION RATE.

Example: Using SetSessionRate

SELECT SetSessionRate(600);
 *** Query completed. One row found. One column returned.
 *** Total elapsed time was 1 second.
SetSessionRate(600)
-----------------------
                     60