16.20 - Utility-session - Teradata Tools and Utilities

Teradata® Call-Level Interface Version 2 Reference for Mainframe-Attached Systems

prodname
Teradata Tools and Utilities
vrm_release
16.20
created_date
September 2019
category
Programming Reference
featnum
B035-2417-108K

Utility-session is used by proprietary utilities and is not intended for other applications. It is described here simply for completeness.

Refers to the session whose CLIv2 connection number is specified in the QEPCONN field. Since they do not apply, the QEPTLEN, QEPRQST, and QEPTOKEN fields must contain binary zeroes.

Returns information for internal use by Teradata utilities. Because new items might be added in the future, the length of the result might vary depending on the active version of CLIv2 or TDP.

Item Code Mnemonic Response DBQERIUS (DbqerUS for C)
Field Value
48 QEPIUS QERUSNI ('nodeid' for C, NODE-ID for Cobol, and NODE_ID for PL/I) A two-byte unsigned integer containing the unformatted Teradata Database node-id associated with the session. A value of zero indicates that the node-id is not available.
Currently, no version of the Teradata Database provides the node-id to mainframe-attached systems, so the value is always zero.
      (Reserved: 2 bytes)
    QERUSRS1 ('rate1Status' for C and C++, RATE1-STATUS for COBOL, RATE1_STATUS for PL/I)
One byte containing the status of the Rate1-actual field, as one of the following:
  • Binary zeroes with mnemonic QERUSRSU ('QER_UtilSess_RateStatusUnused' for C and C++, DBC-UNUSED for COBOL, QER_UTILSESS_RATE_STATUS_UNUSED for PL/I) if the rate field is unused.
  • An EBCDIC space (' ') with mnemonic QERUSRSI ('QER_UtilSess_RateStatusInvalid' for C and C++, DBC-INVALID for COBOL, QER_UTILSESS_RATE_STATUS_INVALID for PL/I) if the rate field is invalid.
  • An EBCDIC letter 'V' with mnemonic QERUSRSV ('QER_UtilSess_RateStatusValid' for C and C++, DBC-VALID for COBOL, QER_UTILSESS_RATE_STATUS_VALID for PL/I) if the rate field is valid.
  • An EBCDIC letter 'O' with mnemonic QERUSRSO ('QER_UtilSess_RateStatusOverflow' for C and C++, DBC-OVERFLOW for COBOL, QER_UTILSESS_RATE_STATUS_OVERFLOW for PL/I) if the rate field has overflowed (that is, can not be contained in eight bytes).

Currently, this field always indicates the rate field is unused.

    QERUSRS2 ('rate2Status' for C and C++, RATE2-STATUS for COBOL, RATE2_STATUS for PL/I)
One byte containing the status of the Rate2-actual field, as one of the following:
  • Binary zeroes with mnemonic QERUSRSU ('QER_UtilSess_RateStatusUnused' for C and C++, DBC-UNUSED for COBOL, QER_UTILSESS_RATE_STATUS_UNUSED for PL/I) if the rate field is unused.
  • An EBCDIC space (' ') with mnemonic QERUSRSI ('QER_UtilSess_RateStatusInvalid' for C and C++, DBC-INVALID for COBOL, QER_UTILSESS_RATE_STATUS_INVALID for PL/I) if the rate field is invalid.
  • An EBCDIC letter 'V' with mnemonic QERUSRSV ('QER_UtilSess_RateStatusValid' for C and C++, DBC-VALID for COBOL, QER_UTILSESS_RATE_STATUS_VALID for PL/I) if the rate field is valid.
  • An EBCDIC letter 'O' with mnemonic QERUSRSO ('QER_UtilSess_RateStatusOverflow' for C and C++, DBC-OVERFLOW for COBOL, QER_UTILSESS_RATE_STATUS_OVERFLOW for PL/I) if the rate field has overflowed (that is, can not be contained in eight bytes).

Currently, this field always indicates the rate field is unused.

    QERUSRS3 ('rate3Status' for C and C++, RATE3-STATUS for COBOL, RATE3_STATUS for PL/I)
One byte containing the status of the Rate1-actual field, as one of the following:
  • Binary zeroes with mnemonic QERUSRSU ('QER_UtilSess_RateStatusUnused' for C and C++, DBC-UNUSED for COBOL, QER_UTILSESS_RATE_STATUS_UNUSED for PL/I) if the rate field is unused.
  • An EBCDIC space (' ') with mnemonic QERUSRSI ('QER_UtilSess_RateStatusInvalid' for C and C++, DBC-INVALID for COBOL, QER_UTILSESS_RATE_STATUS_INVALID for PL/I) if the rate field is invalid.
  • An EBCDIC letter 'V' with mnemonic QERUSRSV ('QER_UtilSess_RateStatusValid' for C and C++, DBC-VALID for COBOL, QER_UTILSESS_RATE_STATUS_VALID for PL/I) if the rate field is valid.
  • An EBCDIC letter 'O' with mnemonic QERUSRSO ('QER_UtilSess_RateStatusOverflow' for C and C++, DBC-OVERFLOW for COBOL, QER_UTILSESS_RATE_STATUS_OVERFLOW for PL/I) if the rate field has overflowed (that is, can not be contained in eight bytes).

Currently, this field always indicates the rate field is unused.

    QERUSRS4 ('rate4Status' for C and C++, RATE4-STATUS for COBOL, RATE4_STATUS for PL/I)
One byte containing the status of the Rate1-actual field, as one of the following:
  • Binary zeroes with mnemonic QERUSRSU ('QER_UtilSess_RateStatusUnused' for C and C++, DBC-UNUSED for COBOL, QER_UTILSESS_RATE_STATUS_UNUSED for PL/I) if the rate field is unused.
  • An EBCDIC space (' ') with mnemonic QERUSRSI ('QER_UtilSess_RateStatusInvalid' for C and C++, DBC-INVALID for COBOL, QER_UTILSESS_RATE_STATUS_INVALID for PL/I) if the rate field is invalid.
  • An EBCDIC letter 'V' with mnemonic QERUSRSV ('QER_UtilSess_RateStatusValid' for C and C++, DBC-VALID for COBOL, QER_UTILSESS_RATE_STATUS_VALID for PL/I) if the rate field is valid.
  • An EBCDIC letter 'O'
  • with mnemonic QERUSRSO ('QER_UtilSess_RateStatusOverflow' for
  • C and C++, DBC-OVERFLOW for COBOL, QER_UTILSESS_RATE_STATUS_OVERFLOW for PL/I) if the rate field has overflowed (that is, can not be contained in eight bytes).

Currently, this field always indicates the rate field is unused.

   

QERUSR1A ('rate1Actual' for C and C++, RATE1-ACTUAL for COBOL, RATE1_ACTUAL for PL/I)

In C compilers not supporting 64bit integers, an array named 'rate1ActualHalf' consisting of two four-byte unsigned integers, each containing four bytes of the value, is used.

An eight-byte unsigned integer that contains the cumulative transmission rate of request data for the session. The rate is the ratio of the number of bytes sent divided by the elapsed time to send. The validity of this field is indicated by the Rate1-status field.
   

QERUSR2A ('rate2Actual' for C and C++, RATE2-ACTUAL for COBOL, RATE2_ACTUAL for PL/I)

In C compilers not supporting 64bit integers, an array named 'rate2ActualHalf' consisting of two four-byte unsigned integers, each containing four bytes of the value, is used.

An eight-byte unsigned integer that contains the cumulative transmission rate of response data for the session. The rate is the ratio of the number of bytes received divided by the elapsed time to receive. The validity of this field is indicated by the Rate2-status field.
   

QERUSR3E ('rate3Effective' for C and C++, RATE3-EFFECTIVE for COBOL, RATE3_EFFECTIVE for PL/I)

In C compilers not supporting 64bit integers, an array named 'rate3EffectiveHalf' consisting of two four-byte unsigned integers, each containing four bytes of the value, is used.

An eight-byte unsigned integer that contains the cumulative transmission rate of request data for the session. The rate is the ratio of the number of bytes sent divided by the elapsed time from when the session was established to when the query was called. The validity of this field is indicated by the Rate3-status field.
   

QERUSR4E ('rate4Effective' for C and C++, RATE4-EFFECTIVE for COBOL, RATE4_EFFECTIVE for] PL/I)

In C compilers not supporting 64bit integers, an array named 'rate4EffectiveHalf' consisting of two four-byte unsigned integers, each containing four bytes of the value, is used.

An eight-byte unsigned integer that contains the cumulative transmission rate of response data for the session. The rate is the ratio of the number of bytes received divided by the elapsed time from when the session was established to when the query was called. The validity of this field is indicated by the Rate4-status field.