DESCRIBE TYPE

描述一个 用户定义的类型。

DESCRIBE 可以缩写为 DESC。

另请参阅：

CREATE TYPE、ALTER TYPE、SHOW TYPES、DROP TYPE、UNDROP TYPE

语法

{ DESC | DESCRIBE } TYPE <name>

参数

name

指定要描述的用户定义类型的标识符。

如果标识符包含空格或特殊字符，则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。

有关更多信息，请参阅 标识符要求。

输出

命令输出在以下列中提供用户定义类型属性和元数据：

列

描述

name

用户定义类型的名称。

type

作为用户定义类型基类型的 Snowflake 类型定义。

created_on

创建用户定义类型的日期和时间。

database_name

存储用户定义类型的数据库。

schema_name

存储用户定义类型的架构。

owner

拥有用户自定义类型的角色名称，即对该用户自定义类型具有 OWNERSHIP 权限的角色。

comment

为类型设置的注释（如果有）；否则为 NULL。

访问控制要求

用于执行此操作的 角色 必须至少具有以下 权限：

权限

对象

备注

任意

用户定义的类型

对架构中的对象进行操作至少需要父数据库的一项权限和父架构的一项权限。

有关创建具有指定权限集的自定义角色的说明，请参阅 创建自定义角色。

有关对 安全对象 执行 SQL 操作的相应角色和权限授予的一般信息，请参阅 访问控制概述。

使用说明

  • 要对该命令的输出进行后处理，可以使用 管道运算符 (->>) 或 RESULT_SCAN 函数。这两种构造都将输出视为可以查询的结果集。

    例如，您可使用管道操作符或 RESULT_SCAN 函数，从 SHOW 命令输出中选择特定列或筛选行数据。

    引用输出列时，为列名使用 双引号标识符。例如，选择输出列 type，指定 SELECT "type"。

    必须使用双引号标识符，因为 SHOW 命令的输出列名均为小写格式。双引号确保 SELECT 列表或 WHERE 子句中的列名，与已扫描的 SHOW 命令输出中的列名完全匹配。

示例

使用 DESCRIBE TYPE 命令列出有关 age 用户定义类型的详细信息：

DESC TYPE age;

+------+-------------+-------------------------------+---------------+-------------+--------------+---------+
| name | type        | created_on                    | database_name | schema_name | owner        | comment |
|------+-------------+-------------------------------+---------------+-------------+--------------+---------|
| AGE  | NUMBER(3,0) | 2025-11-06 09:23:59.882 -0800 | MY_DB         | MY_SCHEMA   | MY_ROLE      | NULL    |
+------+-------------+-------------------------------+---------------+-------------+--------------+---------+