COMMENT ON
適用於: Databricks SQL Databricks Runtime
設定目錄、架構、數據表、共用、收件者、提供者或磁碟區的批注。
注意
如果您想要為 Unity 目錄所管理的數據表或資料表資料行新增 AI 產生的批注,請參閱 將 AI 產生的批註新增至數據表。
只有 Unity 目錄支援目錄、共用、收件者和提供者。
若要設定數據表數據行的批注,請使用 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
參數
-
您註出的目錄名稱。 若要執行此語句,您必須是目錄的擁有者。
-
適用於:Databricks SQL Databricks Runtime 13.3 LTS 和更新版本僅限 Unity 目錄
批注出現所在的連線名稱。 若要執行此語句,您必須是連線的擁有者。
-
批注出現之架構的名稱。
如果您使用 Unity 目錄來執行此語句,您必須是架構的擁有者。
-
您註解的資料表名稱。 名稱不得包含 時態規格。
如果您使用 Unity 目錄來執行此語句,則必須擁有
MODIFY
資料表的許可權。 -
適用於: Databricks SQL Databricks Runtime 11.3 LTS 和更新版本
您的批註出現所在的共享名稱。 若要執行此語句,您必須是共用的擁有者。
-
適用於: Databricks SQL Databricks Runtime 11.3 LTS 和更新版本
您批註出現所在的收件者名稱。 若要執行此語句,您必須是收件者的擁有者。
-
適用於: Databricks SQL Databricks Runtime 11.3 LTS 和更新版本
您批註出現所在的提供者名稱。 若要執行此語句,您必須是提供者的擁有者。
-
適用於: 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';