PERFGROUPS Request | Application Programming Reference | Teradata Vantage - 17.05 - PERFGROUPS - 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 information about the Resource Partitions (RPs) and Performance Groups (PGs) active in the system GDO file.

On database systems running SLES 11 or later systems, this function is obsolete and returns an error.

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.

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

A Resource Partition is a subset of database request-processing resources. The default Resource Partition represents 100% of the system resources. Each Resource Partition contains a number of Performance Groups that have access to the resources available to the Resource Partition. You can define additional Resource Partitions and populate them with Performance Groups.

A Performance Group is a collection users that have access to the resources of the Resource Partition to which they belong. You can assign users to Performance Groups using a MODIFY USER statement. When users log on they can enter the Performance Group as part of the account string. If a user is not assigned to a Performance Group or does not enter one as part of the account string at logon, the system uses the default Performance Group for the session.

There are two types of Resource Partitions and Performance Groups:
  • Those that are set up using the Priority Scheduler function in the schmon utility
    On SLES 11 systems, Priority Scheduler is managed by TASM, and is configured using the Teradata Viewpoint workload management portlets. For more information on those portlets, see Teradata® Viewpoint User Guide, B035-2206.
  • Those that are part of a Teradata dynamic workload management software WD

Only one of these types can be active at any time.

To learn more about Resource Partitions and Performance Groups, see Teradata Vantage™ - Database Utilities , B035-1102 and Teradata Vantage™ - Database Administration, B035-1093.

The PERFGROUPS request returns the set of Resource Partitions and Performance Groups that are currently active.
  • When TASM Workloads are not enabled, the returned set of Resource Partitions or Performance Groups are those defined by the schmon utility.
  • When TASM Workloads are enabled, the returned set of Resource Partitions or Performance Groups are those defined by the Teradata Viewpoint Workload Designer portlet.

CLIv2 Response Parcels

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

ActivityCount = 5

ActivityType = 133 (PCLTWMPERFGROUPSSTMT)

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. One record is returned for each RP slot in the system GDO. The unused slots are padded with blanks. The format of this Resource Partition Record parcel is described below.
EndStatement 11 6 StatementNo = 1
Success 8 18 to 273 StatementNo = 2

ActivityCount = 40

ActivityType = 133 (PCLTWMPERFGROUPSSTMT)

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. One record is returned for each Performance Group slot in the system GDO. The unused slots are padded with blanks. The format of this Performance Group Record parcel is described below.
EndStatement 11 6 StatementNo = 2
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 Resource Partition Record parcel contains the Resource Partition Name field. This field returns the name of the Resource Partition. The names are padded with blanks to fill the entire field.

Resource Partition Name is a VARCHAR data type with a maximum variable length of 16 characters.

The following table describes the format of the Performance Group Record parcel.

Field/Column Name Data Type Description
Performance Group Name VARCHAR (16) Name of the Performance Groups. The names are padded with blanks to fill the entire field.
The unused Performance Groups have names which are all blanks.
Resource Partition Index SMALLINT Index that associates this Performance Group back to one of the Resource Partitions named in a previous Resource Partition record.

Sample Input - CLIv2 Request

The following example illustrates how the parcels for a PERFGROUPS request, built by CLIv2, look when sent to the database server when the mon_ver_id value is not checked. In this example, the size of the response buffer 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 17 Request PERFGROUPS
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

The following examples show typical data sets returned in character text format for the PERGROUPS request.

The PERGROUPS request you submit may return information in a different format.

The original system Performance Groups are saved while the Teradata Viewpoint Workload Designer portlet settings are used and are reactivated if TASM Workloads are disabled.

Sample Output - Using PERFGROUPS to Show User-defined Priority Scheduler Settings

This example shows a representative set of user-defined (using schmon) Priority Scheduler settings that are used by the system when TASM Workloads are disabled.

Submitting request TDWM PERFGROUPS;
Resource Partition items: 5
         Resource Partition Name : Default
         Resource Partition Name : RP1
         Resource Partition Name : standard
         Resource Partition Name :
         Resource Partition Name :
Performance Group items: 40
         RP#: 0,  PG-Name: L
         RP#: 0,  PG-Name: M
         RP#: 0,  PG-Name: H
         RP#: 0,  PG-Name: R
         RP#: 1,  PG-Name: M1
         RP#: 1,  PG-Name: H1
         RP#: 1,  PG-Name: L1
         RP#: 1,  PG-Name: R1
         RP#: 2,  PG-Name: PGWL5
         RP#: 2,  PG-Name: PGWL10
         PG#: 0,  PG-Name:
                 .
                 .
                 .

Sample Output - Using PERFGROUPS to Show Priority Scheduler Settings Created in Teradata Viewpoint Workload Designer

This example shows a representative set of Priority Scheduler settings created in the Teradata Viewpoint Workload Designer portlet that are used by the system when TASM Workloads are enabled.

Submitting request TDWM PERFGROUPS;
Resource Partition items: 5
         Resource Partition Name : DEFAULT
         Resource Partition Name : TACTICAL
         Resource Partition Name : STANDARD
         Resource Partition Name :
         Resource Partition Name :
Performance Group items: 40
         RP#: 0,  PG-Name: L
         RP#: 0,  PG-Name: M
         RP#: 0,  PG-Name: H
         RP#: 0,  PG-Name: R
         RP#: 2,  PG-Name: PGWL3
         RP#: 2,  PG-Name: PGWL5
         RP#: 2,  PG-Name: PGWL4
         RP#: 2,  PG-Name: PGWL2
         RP#: 2,  PG-Name: PGWL1
         RP#: 0,  PG-Name: UNUSED9
         RP#: 0.  PG-Name:
                     .
                     .
                     .