Teradata Dynamic Workload Management API Features | Teradata Vantage - 17.10 - Teradata Dynamic Workload Management API Features - 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)

Teradata dynamic workload management software is a rule-oriented management system capable of detecting and acting on events. It is a key component of Teradata Active System Management (TASM).

Teradata ASM is not fully supported on Teradata appliances. For more information, see appropriate appliance documents for further details.
Teradata Dynamic Workload Management APIs allow database administrators to:
  • Apply updates to the TASM rule categories (For descriptions of these rules, see Teradata® Viewpoint User Guide, B035-2206.)
  • Monitor delayed requests
  • Release or abort requests from the delay queue
  • Display the workload definition of a query
  • Determine the current status of TASM rules and rule sets
  • Review statistics on how TASM rule categories are affecting request processing
  • Retrieve information about the current status of all event-related constructs
  • Enable or disable user-defined events for event management

For information on TASM rules and how to enable the rule categories in the Teradata Viewpoint Workload Designer portlet, see Teradata® Viewpoint User Guide, B035-2206.

For examples on performing these Teradata Dynamic Workload Management functions, see the following examples.

Examples Using Open APIs

The following table describes the different uses of the Teradata Dynamic Workload Management open APIs.

You can execute the ... To ...
MonitorSession and TDWMAssignWD functions change the workload to WD-Report-High of all active requests with a workload of WD-Report-Low.
TDWMEventControl function change the active health condition or planned environment on the system to adjust the throttles.
TDWMEventStatus function display all active events.
TDWMGetDelayedQueries and TDWMReleaseDelayedRequest functions release all delayed queries for a specified workload.
TDWMRuleControl function temporarily enable a rule to block an application for accessing a database while it is synchronized between two active systems.
TDWMSummary function display the current workload summary statistics.
TDWMThrottleStatistics function display the current delay queue statistics.

Functionality

The following table describes the interfaces of the Teradata Dynamic Workload Management that are used to return WDs, delayed query lists, summary data, and statistics; and update the components stored in the Teradata Dynamic Workload Management database.

The updates in the TDWMRuleControl and TDWMSetLimits procedures must be committed before the TDWMApply procedure can be called. If the same transaction is used to call the external stored procedures that update the TDWM database and the TDWMApply external stored procedure, a self-deadlock occurs as shown in the example below.
Bt;
Call TDWMRuleControl() 

The updates are not committed because the TDWMRuleControl procedure is in a transaction (that is, the rows are locked for write).

Call TDWMApply(200, 'Y','N','N','N');

The TDWM database waits on the locked tables.

If you want to ... Use the following SQL interface ... Or the following CLIv2 or Teradata JDBC Driver request ...
abort a request or utility session on the Teradata dynamic workload management software delay queue TDWMAbortDelayedRequest TDWM DELAY REQUEST CHANGE
apply changes to the rules in one or more the Teradata dynamic workload management software categories TDWMApply
change the workload a session or request is assigned to TDWMAssignWD TDWM WD ASSIGNMENT
activate or deactivate a user-defined event TDWMEventControl USER EVENT CONTROL
list all objects that make up the system state TDWMEventMapping EVENT STATUS
return the currently defined events TDWMEventStatus EVENT STATUS
return the collection rate (that is, the first record of the Teradata dynamic workload management software Exception PM/API request) or return Teradata dynamic workload management software exception data from the database TDWMExceptionRate TDWM EXCEPTIONS
collect the Teradata dynamic workload management software exception data from the database TDWMExceptions TDWM EXCEPTIONS
report if each category is active or not TDWMInquire
return the delayed query data fields and delay information TDWMGetDelayedQueries TDWM STATISTICS
return the utility delay queue TDWMGetDelayedUtilities TDWM STATISTICS
return a list of the WDs TDWMListWDs TDWM LIST WD
return the statistics on the load utilities that are available in the system TDWMLoadUtilStatistics TDWM STATISTICS
release a request or utility session on the Teradata dynamic workload management software delay queue TDWMReleaseDelayedRequest TDWM DELAY REQUEST CHANGE
return the Teradata dynamic workload management software WD summary data fields TDWMSummary TDWM SUMMARY
return the collection rate TDWMSummaryRate TDWM SUMMARY
return statistics for throttled database objects or throttled workloads TDWMThrottleStatistics TDWM STATISTICS