DBCAREA: Field Descriptions | Teradata CLIv2 - DBCAREA: Field Descriptions - Call-Level Interface Version 2

Teradata® Call-Level Interface Version 2 Reference for Workstation-Attached Systems - 20.00
Deployment
VantageCloud
VantageCore
Edition
VMware
Enterprise
IntelliFlex
Lake
Product
Call-Level Interface Version 2
Release Number
20.00
Published
January 2024
ft:locale
en-US
ft:lastEdition
2025-11-29
dita:mapPath
bmn1691484839905.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
fvz1470444150352
Product Category
Teradata Tools and Utilities
The DBCAREA contains seven logical sections:
  • Header
  • General Input
  • General Output
  • Function Specific
  • Time Stamp
  • Option
  • Message

Individual fields in these logical sections are illustrated, in sequential order, in the figures that follow.

Byte Number Description
000 Eyecatcher, 8 bytes
004
008 Total Length, 4 bytes
012 Function, 4 bytes
016 Input Session ID, 4 bytes
020 Input Request ID, 4 bytes
024 Request Buffer Length, 4 bytes
028 Response Buffer Length, 4 bytes
032 Maximum Number of Sessions for a Single Process, 4 bytes
036 Token, 4 bytes
040 Return Code, 4 bytes
044 Output Session ID, 4 bytes
048 Output Request ID, 4 bytes
052 Output DBC Path, 8 bytes
056
060 Output DBC Session ID, 4 bytes
064 Output Host ID, 2 bytes Session Status, 1 byte Unused, 1 byte
068 TDP Request Number, 4 bytes (not used)
072 Current Request Buffer Length, 4 bytes
076 Current Response Buffer Length, 4 bytes
080 Input DBC Path, 8 bytes
084
088 Logon Pointer, 4 bytes (unused on 64 bits)
092 Logon Length, 4 bytes
096 Run Pointer, 4 bytes (unused on 64 bit)
100 Run Length, 4 bytes
104 Request Pointer, 4 bytes (unused on 64 bits)
108 Request Length, 4 bytes
112 Using Data Pointer, 4 bytes (unused on 64 bits)
116 Using Data Length, 4 bytes
120 Msg Class, 2 bytes Msg Kind, 2 bytes
124 Mailbox, 6 bytes Mailbox
128 Mailbox Unused, 2 bytes
132 Open Request, 4 bytes
136 Fetch Maximum Data Length, 4 bytes
140 Fetch Data Pointer, 4 bytes
144 Fetch Returned Data Length, 4 bytes
148 Fetch Parcel Flavor, 4 bytes
152 Fetch Error Indicator, 1 byte Unused, 3 bytes
156 TDP-receipt-timestamp, 8 bytes (not used)
160
164 Time1, 4 bytes
168 Time2, 4 bytes
172 Time3, 4 bytes
176 Time4, 4 bytes
180 Time5, 4 bytes
184 Character Set Pointer, 4 bytes
188 MTDP sent, 4 bytes
192 MTDP received, 4 bytes
196 Unused, 16 bytes
|.....| Unused
208 Unused
212 Extension Pointer, 4 bytes
216 Change Options, 1 byte Response Mode, 1 byte Use Presence Bits, 1 byte Keep Response, 1 byte
220 Wait Across Crash, 1 byte Tell About Crash, 1 byte Connect Wait, 1 byte Locate Mode, 1 byte
224 Variable Length Request, 1 byte Variable Length Fetch, 1 byte Save Response, Buffers, 1 byte Two Response, Buffers, 1 byte
228 Return Time, 1 byte Parcel Mode Fetch, 1 byte Wait for Response, 1 byte Request Processing Option, 1 byte
232 Message Security, 1 byte Set Character,Set, 1 byte Connect Type, 1 byte Request Mode, 1 byte
236 2PC, 1 byte Protocol-Function, 1 byte Transaction Semantics, 1 byte Conformance, 1 byte
240 Unused, 2 bytes Message Length, 2 bytes
244 Message Text, 76 bytes
|.....|
312
320 Route Description Codes, 4 bytes
324 Unused, 16 bytes
|.....|
336
340 Unused, 2 bytes Date Form, 1 byte Maximum Parcel, 1 byte
344 LanguageId, 2 bytes Unused, 2 bytes
348 Segment Data, 1 byte Return-objects-as, 1 byte Continuation Code, 1 byte Data Encryption, 1 byte
352 Unused, 1 byte Statement Status, 1 byte Continued Characters State, 1 byte Consider APH Responses, 1 byte
356 Return statement info, 1 byte Return Identity Data, 1 byte Positioning-statement-number, 2 bytes
360 Positioning-value, 8 bytes
364
368 Positioning-action, 2 bytes Timing-precision, 2 bytes
372 DBC Level, 1 byte Unused, 1 byte Message Return Code, 2 bytes
376 Message Length Returned, 2 bytes Message Area Length, 2 bytes
380 Message Area Pointer, 4 bytes (unused on 64 bit)
384 Unused, 8 bytes
388
392 Unused, 8 bytes
396
400 Unused, 8 bytes
404
408 Unused, 8 bytes
412
416 Logon Pointer, 8 bytes (unused on 32-bit)
420
424 Run Pointer, 8 bytes (unused on 32-bit)
428
432 Unused, 8 bytes
436
440 Request Pointer, 8 bytes (unused on 32-bit)
444
448 Unused, 8 bytes
452
456 Using Data Pointer, 8 bytes (unused on 32-bit)
460
464 Unused, 8 bytes
468
472 Unused, 8 bytes
476
480 Unused, 8 bytes
484
488 Fetch Data Pointer, 8 bytes (unused on 32-bit)
492
496 Unused, 8 bytes
500
504 Character Set Pointer, 8 bytes (unused on 32-bit)
508
512 Extension Pointer, 8 bytes (unused on 32-bit)
516
520 Message Area Pointer, 8 bytes (unused on 32-bit)
524
528 Unused, 4 bytes
532 Unused, 1 byte Time1-status, 1 byte Time2-status, 1 byte Time3-status, 1 byte
536 Time4-status, 1 byte Time5-status, 1 byte exempt_sess_from_DBCHWAT, 1byte create_default_connection, 1 byte
540 Using Data Count, 4 bytes
544 logmech_name, 8 bytes
548
552 32-bit: unused, 4 bytes, 64-bit: logmech_data_ptr, 8 bytes
556 32-bit: logmech_data_ptr, 4 bytes
560 logmech_data_len, 4 bytes
564 mechdata_Unicode_set, 1 byte dynamic_result_sets_allowed, 1 byte SP_return_result, 1 byte Send_deligated_credentials, 1 byte
568 32-bit: unused, 4 bytes, 64-bit: using_data_ptr_array, 8 bytes
572 32-bit: using_data_ptr_array, 4 bytes
576 32-bit: unused, 4 bytes, 64-bit: using_data_len_array, 8 bytes
580 32-bit: using_data_len_array, 4 bytes
584 max_decimal_returned, 2 bytes transformsoff, 1 byte periodasstruct, 1 byte
588 workload_len, 4 bytes
592 32-bit: unused, 4 bytes, 64-bit: workload_ptr, 8 bytes
596 32-bit: workload_ptr, 4 bytes
600 logon_timeout, 2 bytes wait_time, 2 bytes
604 Unused, 8 bytes
608
612 trustedRequest, 1 byte columnInfo, 1 byte utilityWorkload, 1 byte multiStatementErrors, 1 byte
616 Unused, 20 bytes
620 Automatic Redrive, 1 byte Extended-load, 1 byte Unused, 2 bytes
621 extendedLoadUsage, 1 byte
|....|        
636 tasmFastFailReq, 1 byte xmlResponseFormat, 1 byte arrayTransformsOff, 1 byte Unused, 1 byte
640 32-bit: unused, 4 bytes, 64-bit: using_SLOB_data_struct, 8 bytes
644 32-bit: using_SLOB_data_struct, 4 bytes
648 MaxSingleLOBBytes, 8 bytes
656 MaxTotalLOBBytesPerRow, 8 bytes
664-679 Unused, 16 bytes
680 32-bit: unused, 4 bytes, 64-bit: connect_ptr, 8 bytes
684 32-bit: connect_ptr, 4 bytes
688 connect_len, 4 bytes
692 sslmode, 1 byte o_sslmode, 1 byte o_port, 2 bytes
696 openTableFormat, 1 byte virtualSystemDict, 1 byte use_local_catalog, 1 byte Unused, 1 byte
700-1019 Unused, 320 bytes
1020 Unused, 1 byte Unused, 1 byte largeRow, 1 byte Unused, 1 byte