COMMENT ON

  • 项目

适用于：勾选“是” Databricks SQL 勾选“是” Databricks Runtime

对目录、架构、表、共享、收件人、提供程序或卷设置注释。

注意

如果要为 Unity Catalog 管理的表或表列添加 AI 生成的注释，请参阅《向表添加 AI 生成的注释》。

目录、共享、接收者和提供者仅在 Unity Catalog 中受支持。

要设置表格列的注释，请使用 ALTER TABLE。

语法

COMMENT ON
    { CATALOG catalog_name |
      CONNECTION connection_name |
      PROVIDER provider_name |
      RECIPIENT recipient_name |
      { SCHEMA | DATABASE } schema_name |
      SHARE share_name |
      TABLE table_name |
      VOLUME volume_name }
    IS comment

parameters

  • catalog_name

    显示注释的目录的名称。 要运行此语句，你必须是目录的所有者。

  • connection_name

    适用于：勾选“是” Databricks SQL 勾选“是” Databricks Runtime 13.3 LTS 及更高版本 勾选“是” 仅 Unity Catalog

    显示注释的连接的名称。 要运行此语句，你必须是连接的所有者。

  • schema_name

    显示注释的架构的名称。

    如果使用 Unity Catalog 运行此语句，则你必须是架构的所有者。

  • table_name

    所注释的表的名称。 名称不得包含时态规范。

    如果使用 Unity Catalog 运行此语句，则必须拥有该表的 MODIFY 权限。

  • share_name

    适用于：勾选“是” Databricks SQL 勾选“是” Databricks Runtime 11.3 LTS 及更高版本

    显示注释的共享的名称。 要运行此语句，你必须是共享的所有者。

  • recipient_name

    适用于：勾选“是” Databricks SQL 勾选“是” Databricks Runtime 11.3 LTS 及更高版本

    显示注释的收件人的名称。 要运行此语句，你必须是收件人的所有者。

  • provider_name

    适用于：勾选“是” Databricks SQL 勾选“是” Databricks Runtime 11.3 LTS 及更高版本

    显示注释的提供程序的名称。 要运行此语句，你必须是提供程序的所有者。

  • volume_name

    适用于：勾选“是” Databricks SQL 勾选“是” Databricks Runtime 13.3 LTS 及更高版本

    显示注释的卷的名称。 若要运行此语句，你必须是卷的所有者。

  • comment

    STRING 文本或 NULL。 如果指定 NULL，则删除任何现有注释。

示例

> COMMENT ON CATALOG my_catalog IS 'This is my catalog';

> COMMENT ON CONNECTION mysql_connection IS 'this is a mysql connection';

> COMMENT ON SCHEMA my_schema IS 'This is my schema';

> COMMENT ON TABLE my_table IS 'This is my table';

> COMMENT ON TABLE my_table IS NULL;

> COMMENT ON SHARE my_share IS 'A good share';

> COMMENT ON RECIPIENT my_recipient IS 'A good recipient';

> COMMENT ON PROVIDER my_provider IS 'A good provider';

> COMMENT ON PROVIDER my_volume IS 'Huge volume';