COMMENT ON

  • [アーティクル]

適用対象:「はい」のチェック マーク Databricks SQL 「はい」のチェック マーク Databricks Runtime

カタログ、スキーマ、テーブル、共有、受信者、プロバイダー、またはボリュームにコメントを設定します。

Note

Unity カタログで管理されているテーブルまたはテーブル列に AI によって生成されたコメントを追加する場合は、「AI によって生成されたコメントをテーブルに追加する」を参照してください。

カタログ、共有、受信者、プロバイダーは、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

    コメントが表示されるカタログの名前。 このステートメントを実行するには、カタログの所有者である必要があります。

  • 接続名

    適用対象:check marked yes Databricks SQL Databricks Runtime 13.3 LTS 以降 「はい」のチェック マーク Unity Catalog のみ

    コメントが表示される接続の名前。 このステートメントを実行するには、接続の所有者である必要があります。

  • schema_name

    コメントが表示されるスキーマの名前。

    Unity Catalog を使用する場合、このステートメントを実行するには、スキーマの所有者である必要があります。

  • table_name

    コメントするテーブルの名前。 この名前には、テンポラル仕様を含めることはできません。

    Unity Catalog を使用する場合、このステートメントを実行するには、テーブルに対する MODIFY 特権を持っている必要があります。

  • share_name

    適用対象:check marked yes Databricks SQL 「はい」のチェック マーク Databricks Runtime 11.3 LTS 以降

    コメントが表示される共有の名前。 このステートメントを実行するには、共有の所有者である必要があります。

  • recipient_name

    適用対象:check marked yes Databricks SQL 「はい」のチェック マーク Databricks Runtime 11.3 LTS 以降

    コメントが表示される受信者の名前。 このステートメントを実行するには、受信者の所有者である必要があります。

  • provider_name

    適用対象:check marked yes Databricks SQL 「はい」のチェック マーク Databricks Runtime 11.3 LTS 以降

    コメントが表示されるプロバイダーの名前。 このステートメントを実行するには、プロバイダーの所有者である必要があります。

  • volume_name

    適用対象:check marked yes 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';