COMMENT ON

  • Статья

Область применения:check marked yes Databricks SQL check marked yes Databricks Runtime

Задает комментарий к каталогу, схеме, таблице, общей папке, получателю, поставщику или тому.

Примечание.

Если вы хотите добавить созданный ИИ комментарий для таблицы или столбца таблицы, управляемого каталогом Unity, см. статью "Добавление комментариев, созданных ИИ" в таблицу.

Каталоги, общие папки, получатели и поставщики поддерживаются только в каталоге 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

Параметры

  • catalog_name

    Имя каталога, в котором отображается комментарий. Для выполнения этой инструкции необходимо быть владельцем каталога.

  • connection_name

    Область применения:check marked yes только каталог Unity Databricks SQL check marked yes Databricks Runtime 13.1 и более поздних check marked yes версий

    Имя подключения, в котором отображается комментарий. Для выполнения этой инструкции необходимо быть владельцем подключения.

  • schema_name

    Имя схемы, в которой отображается комментарий.

    При использовании каталога Unity для выполнения этой инструкции необходимо быть владельцем схемы.

  • table_name

    Имя таблицы, для которой вы добавляете комментарий. Имя не должно содержать временную спецификацию.

    При использовании каталога Unity для выполнения этой инструкции необходимо иметь привилегии MODIFY для таблицы.

  • share_name

    Область применения:check marked yes Databricks SQL check marked yes Databricks Runtime 11.1 и более поздних версий

    Имя общей папки, в которой отображается комментарий. Для выполнения этой инструкции необходимо быть владельцем общей папки.

  • recipient_name

    Область применения:check marked yes Databricks SQL check marked yes Databricks Runtime 11.1 и более поздних версий

    Имя получателя, где отображается комментарий. Для выполнения этой инструкции необходимо быть владельцем получателя.

  • provider_name

    Область применения:check marked yes Databricks SQL check marked yes Databricks Runtime 11.1 и более поздних версий

    Имя поставщика, где появляются ваш комментарий. Для выполнения этой инструкции необходимо быть владельцем поставщика.

  • volume_name

    Область применения:check marked yes Databricks SQL check marked yes Databricks Runtime 13.2 и более поздних версий

    Имя тома, в котором отображается комментарий. Для выполнения этой инструкции необходимо быть владельцем тома.

  • комментарий

    Литерал 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';