TDWM LIST WD Request | Application Programming Reference | Teradata Vantage - 17.05 - TDWM LIST WD - Teradata Database

Teradata Vantage™ - Application Programming Reference

prodname
Advanced SQL Engine
Teradata Database
vrm_release
17.00
17.05
created_date
June 2020
category
Programming Reference
featnum
B035-1090-170K

Purpose

Returns the names of the workloads.

Input Data

Element Data Type Description
IndByte BYTE Indicator bits that specify which fields to treat as NULL if you are using indicator mode.

Each bit in the byte corresponds to one field in the input data.

If data is supplied for that field, set the bit to zero.

If the data for that field is NULL (that is, there is no data supplied for that field), set the bit to 1.

The IndByte field is only required if the CLIv2 request is submitted in indicator mode.
mon_ver_id SMALLINT

NOT NULL

MONITOR software version ID. This can be version 6 or later.

For a general explanation of monitor version choices, see MONITOR VERSION.

enabled_only SMALLINT Enabled workload names.
The values, 0 and 1, return enabled workload names only.

Monitor Privileges

To use this request, you must have the ABORTSESSION and MONSESSION privileges as part of your default role or both privileges must be granted directly to you.

For more information on roles and privileges, see:

Usage Notes

The TDWM LIST WD request returns the WD information from the internal cache being used by the Teradata dynamic workload management software. TASM Workloads must be enabled through the Teradata Viewpoint Workload Designer portlet to use this request. WDs are returned in the order defined for evaluation.

Parcels

Parcel Sequence Parcel Flavor Length (Bytes) Comments/Key Parcel Body Fields
Success 8 18 to 273 StatementNo = 1

ActivityCount = 1 record for each WD being used at the time. There can a maximum of 246.

ActivityType = 161 (PCLTWMLISTWDSTMT)

DataInfo 71 6 to 64100 Optional: This parcel is present if request was IndicData parcel.
Record 10
  • 5 to 64100 (record mode)
  • 6 to 64100(indicator mode)
Depending on the request (Data or IndicData), data is returned in record or indicator mode. There is one WD Information record returned for each WD satisfying the request. The format of this record is described below.
EndStatement 11 6 StatementNo = 1
EndRequest 12 4 None

Response

The statement described below corresponds to a ResultSet returned by the Teradata JDBC Driver, and each of the fields correspond to a ResultSet column returned by the Teradata JDBC Driver. For more information on ResultSets, see Teradata JDBC Driver Reference, available at https://teradata-docs.s3.amazonaws.com/doc/connectivity/jdbc/reference/current/frameset.html .

The following table describes the format of the WD Information Record parcel.

Field/Column Name Data Type Description
Configuration ID SMALLINT Configuration ID of the current rule set.
Enabled Flag SMALLINT Indicator that the workload is currently enabled.
WLC ID INTEGER WD ID for the specified request.
WLC Name VARCHAR (30) WD name.
Characters after the name length are not initialized.

Sample Input - CLIv2 Request

The following example shows how the parcels for a TDWM LIST WD request, built by CLIv2, appear when sent to the database server.

In this example, the size of the response buffer in the example is set at the maximum (64,000 bytes), although you can set it to any size.
Flavor Length Body
Num Name Bytes Field Value
0001 Req 16 Request TDWM LIST WD
0003 Data 4 MonVerID

enabled_only

7

1

0004 Resp 6 BufferSize 64000

Sample Input - Teradata JDBC Driver Request

For an example of how the PM/API request, built in Java, appears when sent to the database server, see Teradata JDBC Driver Reference, available at https://teradata-docs.s3.amazonaws.com/doc/connectivity/jdbc/reference/current/frameset.html .

Sample Output

With an enabled_only value of 1, this example shows only the enabled WDs on the current system in character text format for the LIST WD request when TASM Workloads are enabled. Your application program may return these values in a different format.

Submitting request TDWM LIST WD;
TDWM LIST WD successful.
   
         Config ID   : 1
         Enable Flag : 1
         WLC ID      : 3
         Name Len    : 11
         WLC Name    : WD-ConsoleH
         Config ID   : 1
         Enable Flag : 1
         WLC ID      : 5
         Name Len    : 11
         WLC Name    : WD-ConsoleL
         Config ID   : 1
         Enable Flag : 1
         WLC ID      : 4
         Name Len    : 11
         WLC Name    : WD-ConsoleM
         Config ID   : 1
         Enable Flag : 1
         WLC ID      : 2
         Name Len    : 11
         WLC Name    : WD-ConsoleR
         Config ID   : 1
         Enable Flag : 1
         WLC ID      : 1
         Name Len    : 10
         WLC Name    : WD-Default