DESCRIBE DYNAMIC TABLE¶
Describes the columns in a dynamic table.
DESCRIBE can be abbreviated to DESC.
Syntax¶
DESC[RIBE] DYNAMIC TABLE <name>
Parameters¶
name
Specifies the identifier for the dynamic table to describe. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
Access control requirements¶
A role used to execute this operation must have the following privileges at a minimum:
Privilege |
Object |
Notes |
---|---|---|
SELECT |
The dynamic table that you want to describe. |
Some metadata is hidden if you don’t have the MONITOR privilege. For more information, see Privileges to view a dynamic table’s metadata. |
The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema.
For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.
For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.
Usage notes¶
To DESCRIBE a dynamic table, you must be using a role that has MONITOR privilege on the table.
To post-process the output of this command, you can use the pipe operator (
->>
) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is
type
, then specify"type"
for the identifier.
Examples¶
Describe the columns in my_dynamic_table
:
DESC DYNAMIC TABLE my_dynamic_table;