Поделиться через

COMMENT ON

Область применения:флажок Databricks SQL флажок Databricks Runtime

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

Примечание.

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

Каталоги, общие папки, получатели и поставщики поддерживаются только в каталоге Unity.

Синтаксис

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 relation_name |
      VOLUME volume_name }
    IS comment

Параметры

  • catalog_name

    Имя каталога, в котором отображается комментарий. Чтобы выполнить этот запрос, необходимо быть обладателем прав на каталог или иметь на него привилегию MANAGE.

  • relation_name . имя_столбца

    Применимо: флажок Databricks SQL флажок Databricks Runtime 16.1 и более поздних версий

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

    Примечание.

    Если вы изменяете комментарий столбца для определенного WITH SCHEMA EVOLUTIONпредставления, комментарий будет повторно заполнен из запроса представления на следующей ссылке на представление.

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

    • MODIFY привилегии в таблице.
    • OWNER быть частью представления.

  • connection_name

    применимо:отмечено Databricks SQL отмечено Databricks Runtime 13.3 LTS и выше отмечено Только для каталога Unity

    Название соединения, где появляется ваш комментарий. Чтобы выполнить эту инструкцию, необходимо быть владельцем подключения или иметь в нем права MANAGE.

  • schema_name

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

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

  • relation_name

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

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

    • MODIFY привилегии в таблице.
    • OWNER быть частью представления.

    Требуется, чтобы Databricks Runtime 16.3 и выше были помечены как "да", чтобы комментировать материализованное представление.

  • 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 на нем.

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

    Литерал 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 VOLUME my_volume IS 'Huge volume';
  • Last updated on