共用方式為


COMMENT ON

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

在 catalog、schema、table、共用、收件者、提供者或磁碟區上設定註解。

注意

如果您想要為 Unity Catalog所管理的 table 或 tablecolumn 新增 AI 產生的評論,請參閱 將 AI 產生的評論新增至 Unity Catalog 物件

Unity Catalog 僅支援 Catalogs、shares、recipients和 providers。

若要 settablecolumn的批注,請使用 ALTER TABLE

語法

COMMENT ON
    { CATALOG catalog_name |
      COLUMN relation_name . column_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

    批註 catalogwhere 的名稱隨即出現。 若要執行此語句,您必須是 catalog 的擁有者,或具有 MANAGE 許可權。

  • relation_name 欄位名稱

    適用於:勾選為是 Databricks Runtime 16.1 和更高版本

    您批註之 column 的限定名稱。 relation_name 必須識別檢視或 table。 relation_name 不得包含 時態規格或選項規格

    如果您使用 Unity Catalog,若要執行此語句,則必須在 table上擁有 MODIFY 許可權。

  • connection_name

    適用於:檢查標示為 yes Databricks SQL 檢查標示為 [是] Databricks Runtime 13.3 LTS 和更新版本,檢查標示為 [是], Unity Catalog

    批註 where 連接的名稱隨即出現。 若要執行此語句,您必須是連線的擁有者,或具有 MANAGE 許可權。

  • schema_name

    批註 schemawhere 的名稱隨即出現。

    如果您使用 Unity Catalog來執行此語句,您必須是 schema 的擁有者,或具有 MANAGE 許可權。

  • table_name

    您批註 table 的名稱。 名稱不得包含 時態規格或選項規格

    如果您使用 Unity Catalog,若要執行此語句,則必須在 table上擁有 MODIFY 許可權。

  • share_name

    適用於:核取記號為「是」 Databricks SQL 核取記號為「是」 Databricks Runtime 11.3 LTS 和更新版本

    您的評論出現在共享項目 where 的名稱中。 若要執行此陳述式,您必須是共用的擁有者。

  • recipient_name

    適用於:核取記號為「是」 Databricks SQL 核取記號為「是」 Databricks Runtime 11.3 LTS 和更新版本

    您的批註 where 收件者的名稱隨即出現。 若要執行此陳述式,您必須是收件者的擁有者。

  • provider_name

    適用於:核取記號為「是」 Databricks SQL 核取記號為「是」 Databricks Runtime 11.3 LTS 和更新版本

    您的批註 where 提供者名稱隨即出現。 若要執行此陳述式,您必須是提供者的擁有者。

  • volume_name

    適用於:核取記號為「是」 Databricks SQL 核取記號為「是」 Databricks Runtime 13.3 LTS 和更新版本

    您的評論出現在卷冊 where 的名稱中。 若要執行此語句,您必須是磁碟區的擁有者,或具有該磁碟區的 MANAGE 權限。

  • comment

    STRING 常值或 NULL。 如果您指定 NULL,則任何現有註解將被移除。

範例

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

> COMMENT ON COLUMN my_table.c1 IS 'This is my column';

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