ALTER NOTEBOOK

修改现有 笔记本 的属性。

语法

ALTER NOTEBOOK [ IF EXISTS ] <name> RENAME TO <new_name>

ALTER NOTEBOOK [ IF EXISTS ] <name> SET
  [ COMMENT = '<string_literal>' ]
  [ QUERY_WAREHOUSE = <warehouse_to_run_nb_and_sql_queries_in> ]
  [ IDLE_AUTO_SHUTDOWN_TIME_SECONDS = <number_of_seconds> ]
  [ SECRETS = ('<secret_variable_name>' = <secret_name>) [ , ... ] ]
Copy

参数

name

指定要更改的笔记本的标识符。

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

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

RENAME TO new_name

将笔记本的名称更改为 new_name。新的标识符必须在架构中是唯一的。

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

可以将对象移动到其他数据库和/或架构，同时选择重命名对象。为此，请指定一个限定 new_name 值，该值分别以 db_name.schema_name.object_name 或 schema_name.object_name 的形式包含新数据库和/或架构名称。

备注

  • 目标数据库和/或架构必须已存在。此外，新位置中不能存在同名对象；否则，该语句将返回错误。

  • 除非 对象所有者（即拥有对象 OWNERSHIP 权限的角色）也拥有目标架构，否则禁止将对象移动到托管访问架构。

重命名对象时，引用该对象的其他对象必须使用新名称进行更新。

SET ...

为笔记本设置一个或多个指定的属性或参数：

QUERY_WAREHOUSE = warehouse_name

指定运行笔记本中 SQL 查询的仓库。此参数是可选的。但是，需要运行 EXECUTE NOTEBOOK 命令。

IDLE_AUTO_SHUTDOWN_TIME_SECONDS = number_of_seconds

笔记本自动关闭前的空闲时间秒数。此参数仅适用于在容器运行时运行的笔记本。值必须是介于 60 和 259200（72 小时）之间的整数。

默认值：3600 秒

SECRETS = '(secret_variable_name' = secret_name [ , ... ])

为笔记本设置密钥变量。

  • secret_variable_name – 作为从密钥中检索信息时将在笔记本中使用的变量。

  • secret_name – Snowflake 密钥的名称。

UNSET ...

取消设置笔记本的一个或多个指定属性或参数，以将属性重置为默认值：

  • QUERY_WAREHOUSE

  • COMMENT

要使用单个 ALTER 语句取消设置多个属性或参数，请使用逗号分隔每个属性或参数。

取消设置属性或参数时，只指定属性或参数名称（除非上述语法表明您应该指定值）。指定值会返回错误。

访问控制要求

用于执行此 SQL 命令的 角色 必须至少具有以下 权限：

权限

对象

备注

USAGE 或 OWNERSHIP

笔记本

OWNERSHIP 是对对象的特殊权限，会自动向对象的创建角色授予。

请注意，对架构中的对象进行操作还需要对父数据库和架构具有 USAGE 权限。

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

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

使用说明

  • 关于元数据：

    注意

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

示例

以下示例将名为 my_notebook 的笔记本重命名为 notebook_v2：

ALTER NOTEBOOK my_notebook RENAME TO notebook_v2;
Copy

以下示例取消设置了 QUERY_WAREHOUSE 属性：

ALTER NOTEBOOK my_notebook UNSET QUERY_WAREHOUSE;
Copy
语言: 中文