Using the Teradata Call-Level Interface Version 2 Reference for Workstation-Attached Systems Content
This guide provides information about Teradata® Call-Level Interface Version 2 for Workstation-Attached Systems (CLIv2). CLIv2 is a library of routines that enable an application program to access data on an Analytics Database.
Why Would I Use this Content?
- If you are a system or application programmer, use this content for writing programs to access data on the Analytics Database.
- If you are a system or database administrator, use this content for managing and troubleshooting the application.
How Do I Use this Content?
Use this guide to learn about:
- Features of the CLIv2 interface
- Interaction between an application and the Teradata server through CLI
- Required files for UNIX, Windows, and macOS platforms
- Details on the clispb.dat file that contains the system-specific defaults to be used when a DBCAREA is initialized
- DBCAREA, a data structure shared by the application program and CLI
- CLI routines including description, parameters, and usage notes
- Parcel structure, types, and fields
- Request buffers, response buffers, and Teradata SQL response sequences
- Return, error, and failure codes
- Handling crashes if a workstation-attached system crashes
- Structure of alternate parcel header (APH)
- Supporting a message with a size greater than 64K
- CLI Exit function details such as parameters and security
- Large objects (LOBs) and the methods supported for handling LOB data
- Options to control whether TLS encryption is used and the level of server certificate verification
- Details on how timestamps are used to measure various CLIv2 processing times
- User aids for identifying and rectifying the errors that might occur during a CLIv2 task
- Examples
How Do I Get Started?
- If you are new to CLIv2 or want to learn about the supported data structures or routines, start with the Overview section.
- If you are an administrator and want to manage CLIv2, start with the Return, Error, and Failure Codes and Performance Measurement sections.