DESCRIBE Syntax - Teradata VantageCloud Lake

Lake - Working with SQL

Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2025-11-21
dita:mapPath
jbe1714339405530.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
jbe1714339405530
DESCRIBE statement_name INTO [:] descriptor_area
  [ USING { NAMES | ANY | BOTH | LABELS } ]
  [ FOR STATEMENT { statement_number | [:] statement_number_variable } ]

Syntax Elements

statement_name
The name associated with the previously prepared statement. Must be a valid SQL identifier, not enclosed within apostrophes.
descriptor_area
The area to get the information about the data to be returned when the previously prepared statement is run.
Must identify an SQLDA.
You can specify descriptor_area in C programs as a name or as a pointer reference (*sqldaname) when SQLDA is declared as a pointer. See Teradata® Preprocessor2 for Embedded SQL Programmer Guide, B035-2446.
statement_number
The statement number within the request for which the information is required.
Must be a valid integer numeric literal.
statement_number_variable
The statement number within the request for which the information is required.
Must identify a host variable of type INTEGER or SMALLINT.