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

Данные документа в каталоге Обозреватель с помощью примечаний Markdown

  • Статья

Пользователи могут использовать Обозреватель каталога для просмотра комментариев о ресурсах данных, таких как каталоги, схемы и таблицы. В этой статье описывается, как владельцы объектов или пользователи с разрешением на изменение объектов могут добавлять эти комментарии вручную с помощью Обозреватель каталога.

Примечание.

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

Если вы используете каталог Unity, вы можете использовать Обозреватель каталога для добавления и изменения комментариев ко всем объектам, кроме тех, которые в каталоге Delta Sharing.

Для данных в хранилище метаданных Hive можно использовать Обозреватель каталога только для редактирования примечаний к таблицам.

Markdown предоставляет надежный набор параметров для документирования данных, повышая возможности пользователей Azure Databricks для повышения возможности обнаружения и понимания общих ресурсов данных. Использование комментариев Markdown не влияет на производительность запросов. Markdown не отображается при возврате операторами DESCRIBE .

Добавление примечаний Markdown к объектам данных с помощью Обозреватель каталога

В Обозреватель каталога отображаются комментарии для каталогов, схем, таблиц и других ресурсов под именем объекта.

  • Если комментарий не существует, отображается параметр "Добавить комментарий ".
  • Вы можете переключать отображение комментариев с помощью параметров "Скрыть комментарий " и "Показать комментарий ".

Markdown в примечаниях к таблицам отображается в каталоге Обозреватель сразу после сохранения изменений.

  • Щелкните значок карандаша, чтобы изменить комментарии.
  • Нажмите кнопку " Сохранить", чтобы обновить комментарии.

Вы также можете использовать SQL для добавления примечаний к таблицам во время создания таблицы или ALTER TABLE действий.

При изменении комментариев к таблице SET TBLPROPERTIES Delta Lake операция в журнале таблиц записывает SQL-запрос, используемый для определения текущих примечаний к таблице.

Пример поддерживаемой документации markdown

Обозреватель каталога поддерживает базовый синтаксис Markdown. Нельзя использовать markdown для эмодзи, изображений и отрисованных таблиц markdown. Каталог Обозреватель отображает только два уровня заголовков Markdown.

В следующем примере показан блок кода необработанной разметки. Скопируйте эту разметку в комментарий в каталоге Обозреватель и нажмите кнопку "Сохранить в режиме предварительного просмотра".

# Header 1
## Header 2

**bold text**

*italics text*

~~strikethrough text~~

`monospace text`

---

> Block quote

Ordered list:
1. Item 1
1. Item 2
1. Item 3

Unordered list:
- Item a
- Item b
- Item c

def my_function(): возврат my_value


[Link](https://www.markdownguide.org/cheat-sheet/#basic-syntax)

Дополнительные ресурсы

Для добавления комментариев в объекты данных можно также использовать следующие функции:

  • Команда COMMENT ON . Этот параметр не поддерживает комментарии к столбцам.
  • Параметр COMMENT при использовании CREATE <object> команды или ALTER <object> команды. Например, см. статью CREATE TABLE [USING] и ALTER TABLE. Этот параметр поддерживает примечания столбцов.
  • Примечания, созданные ИИ (также известные как документация по искусственному интеллекту) в Обозреватель каталога. Вы можете просмотреть комментарий, предлагаемый большой языковой моделью (LLM), которая учитывает метаданные таблицы, такие как схема таблицы и имена столбцов, и изменить или принять комментарий как есть, чтобы добавить его. Этот параметр поддерживает только таблицы и столбцы. См. статью "Добавление комментариев, созданных ИИ" в таблицу.