16.20 - DBCHCL RSUP Function - 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

Purpose

RSUP (RunStartUp) sends a request to Teradata Database to execute the startup request stored on Teradata Database.

Usage Notes

  • The application should call the ERQ function after processing RunStartUp, regardless of the success or failure of the startup. This will release internal resources used during startup processing.
  • If RunStartUp is called without first calling Connect, RunStartUp will perform the Connect. In this case, the information needed for a Connect call should be supplied when doing the RunStartUp call.
  • If Return Code is 0, the application must invoke the FET function to process the response.

DBCAREA Input Fields

Before using the Run StartUp function, the application must set the DBCAREA fields in the first table and may optionally set those in the second table depending on the application's requirements.

DBCAREA Input Fields Required for the RunStartUp Function
Function Input-CLIv2-connection-number
DBCAREA Output Fields Optional for the RunStartUp Function
Anticipated-number-of-concurrent-sessions APH-response-OK
Array-transforms-off Change-options
Column-info C2S-conversion
Continued-character-state Data-encryption
Inhibit-buffer-expansion Input-TDP-path
Keep-response Locate-mode
Logon-length Logon-pointer
Max-decimal-returned Maximum-parcel
Multi-statement-errors Parcel Mode
Period-as-struct Refresh-cached-data
Request-buffer-length Request-parcel-format
Request-processing-option Request-token
Response-buffer-length Response-mode
Return-time Return-identity-data
Result-sets-OK Return-result-to
Return-statement-info Row-count
Run-length Run-pointer
Save-response-buffer S2C-conversion
Tell-if-delay Transforms-off
Trusted-request Two-response-buffers
Use-presence-bits Varying-length-request
Varying-length-fetch Wait-during-delay
Wait-exclusion Wait-for-response
XML-response-format  

DBCAREA Output Fields

Upon completion of the Run StartUp function, CLIv2 will always set DBCAREA fields in the first table and will set those in the second table if the function was successful.

DBCAREA Output Fields Always Set by the RunStartUp Function
Current-response-buffer-length Message-return-code
Message-text Message-text-length
Output-CLIv2-request-number Return Code
DBCAREA Output Fields Set by Successful RunStartUp Functions
Current-request-buffer-length Message-return-code
Message-text Message-text-length
Open-requests Output-TDP-request-number