ALTER TYPE

修改现有属性 用户定义类型 的属性。

另请参阅：

CREATE TYPE、DESCRIBE TYPE、SHOW TYPES、DROP TYPE、UNDROP TYPE

语法

ALTER TYPE [ IF EXISTS ] <name> SET
  COMMENT = '<string_literal>'

ALTER TYPE [ IF EXISTS ] <name> UNSET COMMENT

参数

name

指定要更改的用户定义类型的标识符。

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

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

SET ...

指定要为用户定义类型设置的属性：

COMMENT = 'string_literal'

为用户定义类型添加注释或覆盖现有注释。

UNSET ...

指定要为用户定义类型取消设置的属性，将其重置为默认值。

目前，唯一可以取消设置的属性是 COMMENT，它会移除用户定义类型的注释（如果存在）。

访问控制要求

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

权限

对象

备注

OWNERSHIP

用户定义的类型

OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

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

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

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

使用说明

  • 关于元数据：

    注意

    客户应确保在使用 Snowflake 服务时，不会将个人数据（用户对象除外）、敏感数据、出口管制数据或其他受监管数据作为元数据输入。有关更多信息，请参阅 Snowflake 中的元数据字段。

示例

将注释添加到 age 用户定义类型：

ALTER TYPE age SET COMMENT = 'User-defined type for storing age values';

从 age 用户定义的类型中移除注释：

ALTER TYPE age UNSET COMMENT;