分享方式：

COMMENT ON

  • 文章

適用於：核取記號為「是」 Databricks SQL 核取記號為「是」 Databricks Runtime

設定目錄、結構描述、資料表、共用、收件者、提供者或磁碟區的註解。

注意

如果您想要為 Unity Catalog 所管理的資料表或資料表資料行新增 AI 產生的註解，請參閱將 AI 產生的註解新增至 Unity Catalog 物件。

僅 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

參數

  • 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';