15.00 - 15.10 - Workload Management Application Programming Interface - Teradata Database

Teradata Database Introduction to Teradata

Teradata Database
Release Number
Content Type
User Guide
Publication ID
English (United States)
Last Update

Workload management API consists of interfaces to PM/APIs and open APIs. You can use these interfaces to:

  • Monitor system and session-level activities.
  • Monitor Teradata Active System Management (ASM) activity.
  • Track system usage and manage task priorities.
  • Retrieve data from the Priority Scheduler.
  • For more information about the APIs, see Application Programming Reference.


    PM/APIs provide access to PMPC routines resident in Teradata Database. The PMPC subsystem is available through a logon partition called MONITOR, using a specialized PM/API subset of CLIv2 or Teradata JDBC Driver.

    PM/APIs have the following features:

  • CLIv2 or Teradata JDBC Driver data is acquired in near real time, with less overhead and minimal possibility of being blocked. These capabilities allow frequent in-process performance analysis.
  • CLIv2 request saves the raw data in an in-memory buffer where a client application program can easily retrieve the data for real-time analysis or importing into custom reports. The Teradata JDBC Driver returns the data as a JDBC ResultSet where a client application program can easily retrieve the data.
  • CLIv2 or Teradata JDBC Driver request provides access to data that the resource usage does not. For example, session-level resource usage data, and data on application locks and which application is being blocked.
  • Using PM/APIs may not be the right choice for all performance monitoring requirements. Standard performance monitoring tools and reports, such as resource usage reports, may be sufficient.

    For details, see Application Programming Reference.

    Open API

    The workload management open API provides an SQL interface to the PMPC subsystem and Teradata Database system through user-defined functions, embedded services functions, and external stored procedures.

    Most of the SQL interfaces available to the PMPC subsystem provide similar functionality to the CLIv2 or Teradata JDBC Driver requests.

    Note: Most open APIs do not follow transaction rules. If a transaction calls a UDF or external stored procedure and the transaction rolls back, the action of the UDF or external stored procedure is not rolled back. However, the external stored procedures that update the TDWM database must follow the transaction rules. If a transaction calls one of these external stored procedures and the transaction is aborted, the update will be rolled back.

    For more information on the SQL interfaces described in this section and the differences between the open API and PM/API, see Application Programming Reference.

    For more information on the topics presented in this chapter, see the following Teradata Database and Teradata Tools and Utilities books.


    IF you want to learn more about…


    SQL Applications, including:

  • Client Applications
  • Embedded SQL Applications
  • SQL Stored Procedures and Embedded SQL
  • Teradata Preprocessor2 for Embedded SQL Programmer Guide
  • Macros as SQL Applications

  • SQL Fundamentals
  • SQL Data Definition Language
  • SQL Data Manipulation Language
  • Teradata Database SQL stored procedures as SQL applications

  • SQL Fundamentals
  • SQL Stored Procedures and Embedded SQL
  • The EXPLAIN Request Modifier

  • SQL Data Manipulation Language
  • SQL Request and Transaction Processing
  • Third-Party Development, including:

  • TS/API
  • Workload Management APIs
  • Teradata Transparency Series/ Application Programming Interface User Guide
  • Application Programming Reference