共用方式為

COMMENT ON

  • 發行項

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

設定目錄、架構、數據表、共用、收件者、提供者或磁碟區的批注。

注意

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

只有 Unity Catalog 支援目錄、共用、收件者和提供者。

若要設定資料表資料列的批註，請使用 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

參數

  • catalog_name

    您的評論出現的目錄名稱。 若要執行此語句，您必須是目錄的擁有者，或具有該目錄的 MANAGE 許可權。

  • relation_name 。 欄位名稱

    適用於：檢查標示為 yes Databricks SQL 檢查標示為 yes Databricks Runtime 16.1 和更新版本

    您註解欄位的限定名稱。 relation_name 必須識別檢視或數據表。 relation_name 不得包含 時態規格或選項規格。

    如果您使用 Unity 目錄來執行此語句，則必須在資料表上擁有 MODIFY 許可權。

  • connection_name

    適用於：檢查標記為「是」 Databricks SQL 檢查標記為「是」 Databricks Runtime 13.3 LTS 和更新版本，檢查標記為「是」 Unity Catalog

    批注出現所在的連線名稱。 若要執行此語句，您必須是連線的擁有者，或具有 MANAGE 許可權。

  • schema_name

    批注出現之架構的名稱。

    如果您使用 Unity 目錄來執行此語句，您必須是架構的擁有者，或具有其 MANAGE 許可權。

  • table_name

    您評論的資料表名稱。 名稱不得包含 時態規格或選項規格。

    如果您使用 Unity 目錄來執行此語句，則必須在資料表上擁有 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 和更新版本

    批註出現所在的磁碟區名稱。 若要執行此語句，您必須是磁碟區的擁有者，或具有該磁碟區的 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';