17.10 - PM/APIs - 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)

This section describes the Teradata Dynamic Workload Management interfaces that use CLIv2 or the Teradata JDBC Driver. These interfaces are referred to as PM/API requests.

For details on using the Teradata JDBC Driver requests, see Teradata JDBC Driver Reference, available at https://teradata-docs.s3.amazonaws.com/doc/connectivity/jdbc/reference/current/frameset.html.

Before using the Teradata Dynamic Workload Management PM/APIs, read the following topic on the impact of object name length on PM/APIs requests.

Impact of Object Name Length on PM/API Requests

Object names contain 128 Unicode characters; however, to use object names of 128 characters, applications must use monitor software version 10 or later.

If your custom application uses monitor software version ... The object field in the input area can be ...
8 or earlier CHAR(30). A fixed parcel field size of 30 bytes. The names must be padded with spaces.

For more information on monitor software version 8 or earlier, see previous releases of Workload Management API: PM/API and Open API.

9 VARCHAR(120). A parcel field size of up to 120 bytes in variable length.

For more information on monitor software version 9, see Application Programming Reference: Workload Management for Teradata Database 14.0.

10 or later VARCHAR(512). A parcel field size of up to 512 bytes in variable length in host character set format.

Depending on the version of your custom application, some of the PM/API request output fields for object names may be truncated. For example, if the output field is an object name of 100 bytes in length when converted to host character set format, and you are using a PM/API request with monitor software version 8 or earlier, the database name will be truncated to fit the fixed parcel field size of 30 bytes.