DESCRIBE TYPE¶
Describes a user-defined type.
DESCRIBE can be abbreviated to DESC.
- See also:
CREATE TYPE , ALTER TYPE , SHOW TYPES , DROP TYPE , UNDROP TYPE
Syntax¶
Parameters¶
nameSpecifies the identifier for the user-defined type 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.
For more information, see Identifier requirements.
Output¶
The command output provides user-defined type properties and metadata in the following columns:
Column |
Description |
|---|---|
|
Name of the user-defined type. |
|
Snowflake type definition that is the base type for the user-defined type. |
|
Date and time when the user-defined type was created. |
|
Database in which the user-defined type is stored. |
|
Schema in which the user-defined type is stored. |
|
Name of the role that owns the user-defined type, which is the role that has the OWNERSHIP privilege on the user-defined type. |
|
The comment set for the type, if any; otherwise, it is |
Access control requirements¶
A role used to execute this operation must have the following privileges at a minimum:
Privilege |
Object |
Notes |
|---|---|---|
Any |
User-defined type |
Operating on an object in a schema requires at least one privilege on the parent database and at least one privilege on the parent 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 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.For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.
When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column
type, specifySELECT "type".You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.
Examples¶
Use the DESCRIBE TYPE command to list details about the age user-defined type: