16.20 - StatementStatus—Parcel Data - 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

The following information applies to the StatementStatus parcel.

Flavor Mnemonic TRDSPBTU
Field Length Value
205 TRDSPFTU PBTUST 1 byte unsigned integer The status of the statement, as one of the following:
  • 0 if Success or OK
  • 1 if Error
  • 2 if Failure
  • 3 if Statement-Error
PBTURM 1 byte unsigned integer When the status is Success or OK, the Response-mode, if applicable, specified for the request, as one of the following:
  • 0 if not applicable
  • 1 if Field mode
  • 2 if Record mode
  • 3 if Indicator mode
  • 4 if Multipart-indicator mode
  2 byte unsigned integer Bytes that are currently unused.
PBTUSNUM 4 byte unsigned integer The number of the Teradata SQL statement in the request.
PBTUCODE 2 byte unsigned integer When the status is Error, Failure, or Statement-Error, the Database error code, described in the Teradata Messages manual (B035-1096), where the error code is the message number.
PBTUATYP 2 byte unsigned integer When the status is Success or OK, the encoded representation of the Teradata SQL statement. See Activity Type for more information.
PBTUACNT 8 byte unsigned integer When the status is Success or OK, the total number of records selected, inserted, updated, or deleted by the statement.
PBTUFCNT 8 byte unsigned integer When the status is Success or OK, the total number of fields returned in each record.
  4 byte unsigned integer Bytes that are currently unused.

The rest of the parcel, if any, consists of one or more self-defining expressions that supply any context-dependent information. Each extension begins with the following header:

TRDSAUXI
Field Length Description
PBTUXIID 2 byte unsigned integer Information identifier, as one of the following:
  • 1 if warning message
  • 10 if Merge activity counts
  • 27 if TDP generated the response
  • 32 if Maximum response-row size
PBTUXILN 4 byte unsigned integer Number of bytes of data, not including this header.

Following the standard header is data that depends upon the information id.

The Warning Message Extension

The Warning Message extension consists of the following information:

TRDSAUWM
Field Length Description
PBTUWMIH 6 bytes The extension header described in above as the TRDSAUXI area.
PBTUWMCD 2 byte unsigned integer The Database warning code, described in the Messages manual, where the warning code is the message number.
PBTUWMCO 2 byte unsigned integer The Database origin of the warning code. Currently unused. If it is used in the future, it will be described in the Teradata Messages (B035-1096) manual.
PBTUWMTL 4 byte unsigned integer The length, in bytes, of the message.
PBTUWMTX Characters in the character set when the request was initiated, for the number of bytes defined by the PBTUWMTX field. For character sets allowing multiple bytes per character, the number of characters may be less than the number of bytes. The text of the message.

The Merge Activity Counts Extension

The Merge Activity Counts extension consists of the following information:

TRDSAUMC
Field Length Description
PBTUMCIH 6 bytes The extension header described above as the TRDSAUXI area.
PBTUMCI 8 byte unsigned integer The total number of records inserted by the statement.
PBTUMCU 8 byte unsigned integer The total number of records updated by the statement.
  8 byte unsigned integer Bytes that are currently unused.

The TDP-Generated Response Extension

The TDP-Generated Response extension consists of the following information:

TRDSAUTG
Field Length Description
PBTUTGIH 6 bytes The extension header described above as the TRDSAUXI area.
PBTUTGR 1 byte unsigned integer One of the following:
  • 1 if the request was satisfied from a pool
  • 2 if the Database response had been lost
PBTUGE 8 bits Any exceptions that occurred when building the response, each indicated by a specific bit, more than one of which can be present, as follows:
  • hexadecimal 80 if including the user name would have exceeded the response buffer

The Maximum Response-record Size Extension

The Maximum Response-record Size extension consists of the following information:

TRDSAUMC
Field Length Description
PBTUMRIH 6 bytes The extension header described above as the TRDSAUXI area.
PBTUMRAM 4 byte unsigned integer The size of the largest record in the response that is greater than 65535 bytes. If all records are less than 65535 bytes, the value is zero.
PBTUMRRC 8 byte unsigned integer The number of records greater than 65535 bytes in the response. If all records are less than 65535 bytes, the value is zero.