COMMENT ON
適用対象: Databricks SQL Databricks Runtime
カタログ、スキーマ、テーブル、共有、受信者、プロバイダー、またはボリュームにコメントを設定します。
Note
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
パラメーター
-
コメントが表示されるカタログの名前。 このステートメントを実行するには、カタログの所有者である必要があります。
-
適用対象: Databricks SQL Databricks Runtime 13.3 LTS 以降 Unity Catalog のみ
コメントが表示される接続の名前。 このステートメントを実行するには、接続の所有者である必要があります。
-
コメントが表示されるスキーマの名前。
Unity Catalog を使用する場合、このステートメントを実行するには、スキーマの所有者である必要があります。
-
コメントするテーブルの名前。 名前には、 時仕様またはオプション指定を含めてはなりません。
Unity Catalog を使用する場合、このステートメントを実行するには、テーブルに対する
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';
関連記事
- CREATE CATALOG
- DESCRIBE CATALOG
- DROP CATALOG
- ALTER SCHEMA
- CREATE SCHEMA
- DESCRIBE SCHEMA
- DROP SCHEMA
- ALTER TABLE
- CREATE TABLE
- DESCRIBE TABLE
- DROP TABLE
- ALTER SHARE
- CREATE SHARE
- DESCRIBE SHARE
- DROP SHARE
- ALTER RECIPIENT
- CREATE RECIPIENT
- DESCRIBE RECIPIENT
- DROP RECIPIENT
- ALTER PROVIDER
- DESCRIBE PROVIDER
- DROP PROVIDER
- ALTER VOLUME
- DESCRIBE VOLUME
- DROP VOLUME