Вики Unity Catalog

Important

Эта функция доступна в бета-версии. Администраторы учетных записей могут управлять доступом к этой функции на странице «Предварительные версии» в консоли учетной записи. См. статью "Управление предварительными версиями на уровне учетной записи".

Вики-страница позволяет вашей команде задокументировать смысл, предполагаемое использование и источники таблицы, а затем совместно работать с этой информацией непосредственно в Catalog Explorer. Владельцы и управляющие данными составляют и публикуют вики, чтобы отразить бизнес-контекст, относящийся к таблице, например, определения и известные оговорки. Любой, кто может просматривать метаданные таблицы, может прочитать опубликованную страницу вики, комментировать её, предложить правки и отреагировать на неё.

Вики документирует одну таблицу. Страница определяет бизнес-концепцию, охватывающую множество активов. Используйте вики для контекста конкретной таблицы, а страницу — для общего определения.

Вики работают параллельно с существующим комментарием таблицы. Смотрите Вики и комментарии к таблицам.

Что содержится в вики

Вики содержит следующие поля:

Field Description
Description Однострочное резюме таблицы, показанное в верхней части вики.
Основная часть страницы Документация в формате форматированного текста, поддерживающая заголовки, ссылки, изображения и встроенные упоминания защищаемых объектов Unity Catalog и объектов рабочего пространства.
Sources Ссылки на страницы или внешние источники, на которых основан контент вики.

Опубликованная вики на вкладке «Обзор» таблицы в Catalog Explorer с описанием, разделами основной части страницы и ссылкой на источники

Permissions

Вики — это не защищаемый объект. Это метаданные у таблицы, поэтому существующие права Unity Catalog на таблицу определяют, что вы можете делать с её вики. Для информации о привилегиях Unity Catalog см. концепции модели разрешений Unity Catalog.

Таблица привилегий, приведённая ниже, использует привилегии использования на родительских объектах, чтобы обозначить привилегии использования, которые требуются для того, чтобы READ_METADATA, MANAGE или владение вступили в силу. Они зависят от объекта:

  • Таблица: USE SCHEMA в родительской схеме и USE CATALOG в родительском каталоге.
  • Схема: USE CATALOG в родительском каталоге.
  • Каталог: Нет.
Action Необходимые привилегии
Просматривайте и работайте совместно с опубликованными вики: просматривайте опубликованные вики, добавляйте, редактируйте или удаляйте свои комментарии, предлагайте правки и добавляйте реакции Один из следующих:
  • SELECT на столе, USE SCHEMA на схеме и USE CATALOG в каталоге
  • BROWSE в родительском каталоге
  • READ_METADATA для таблицы, схемы, каталога или метахранилища с правами использования родительских объектов
  • MANAGE на таблице, схеме или каталоге, с правами использования на родительские объекты
  • Владелец таблицы, родительской схемы или родительского каталога, с правами использования на родительские объекты
  • Администратор хранилища метаданных
Просмотр черновиков вики Один из следующих:
  • READ_METADATA для таблицы, схемы, каталога или метахранилища с правами использования на родительские объекты
  • MANAGE на таблице, схеме или каталоге, с правами использования родительских объектов
  • Владелец таблицы, родительской схемы или родительского каталога, с правами использования на родительские объекты
  • Администратор хранилища метаданных
Управление вики и комментариями: создавать, редактировать, публиковать или снимать вики с публикации, принимать или отклонять предлагаемые правки, а также удалять любые комментарии Один из следующих:
  • MANAGE на таблице, схеме или каталоге, с привилегиями USAGE на родительские объекты
  • Владелец таблицы, родительской схемы или родительского каталога, с правами использования на родительские объекты
  • Администратор хранилища метаданных

Создайте вики

Чтобы создать вики, нужны права на управление вики в таблице. См. раздел "Разрешения".

Вы можете написать вики вручную или составить её с помощью Genie Code.

Warning

Данные Wiki шифруются в состоянии покоя с помощью ключей, управляемых Microsoft. Вики не поддерживают шифрование с помощью ключей, управляемых клиентом (CMK). Не включайте личные данные, регулируемые данные или другую конфиденциальную информацию в описания вики или тела страниц.

  1. В Catalog Explorer откройте таблицу.

  2. На вкладке «Обзор » нажмите «Создать вики». Если вы закрыли баннер Create wiki, нажмите значок меню «кебаб». в правом верхнем углу страницы и вместо этого выберите Create wiki. Если в таблице уже есть существующий комментарий, он заполняет содержимое страницы вики.

    Баннер Create wiki над описанием таблицы на вкладке Overview

  3. Добавьте контент вики:

    • Чтобы написать вручную, заполните описание и тело страницы, а также добавьте любые источники.
    • Чтобы создать черновик с помощью Genie Code, используйте панель Genie Code в редакторе вики. Прикрепляйте файлы или другой контекст для работы Genie Code. См. код Genie.

  4. Нажмите «Сохранить как черновик», чтобы продолжить работу над вики, или нажмите «Опубликовать», чтобы сделать её видимой для всех, кто может просматривать метаданные таблицы.

После публикации вики она появляется в верхней части вкладки «Обзор » таблицы, а «Описание » перемещается на вкладку «Детали ».

Редактировать и публиковать вики

Чтобы редактировать, публиковать или отменять публикацию вики, необходимы права на управление вики в таблице. См. раздел "Разрешения".

  1. В Catalog Explorer откройте таблицу.

  2. В вики нажмите Редактировать.

  3. Внесите изменения, затем нажмите «Сохранить», чтобы сохранить их, или нажмите «Опубликовать», чтобы сделать черновик вики видимым.

    Черновик вики в режиме редактирования с кнопками «Отмена», «Сохранение» и «Публикация»

Чтобы скрыть опубликованную вики, не потеряв её содержимое, нажмите «Редактировать», выберите меню «Кебаб» и затем «Отменить публикацию». Вики откатывается к черновику, который могут видеть только пользователи, которые могут просматривать черновики. Пока вы не опубликуете вики снова, описание таблицы отображается в верхней части вкладки «Обзор ».

Опция «Отменить публикацию» в меню кебаба опубликованной вики в режиме редактирования

Совместная работа в вики

Любой, кто может просматривать опубликованную вики, может совместно работать с ней. См. раздел "Разрешения".

  • Комментарий: Задавайте вопросы или добавляйте контекст. Вы можете редактировать или удалять свои собственные комментарии.
  • Предлагайте правки: Предлагайте изменения в теле страницы вики. Нажмите «Предложить», отредактируйте текст страницы и нажмите «Сохранить». Пользователь, обладающий правами на управление вики, принимает или отклоняет предложение.
  • React: Поставьте лайк или минус вики, чтобы показать, была ли она полезной.

Вики и комментарии по таблицам

Вики не заменяет комментарий к таблице, поэтому существующие конвейеры, которые читают или пишут комментарии, продолжают работать:

  • Вы всё равно можете задать комментарий с помощью COMMENT ON TABLE или ALTER TABLE. Комментарий всё ещё по-прежнему отображается в information_schema и в поле Описание в Catalog Explorer.
  • Когда вы создаёте вики, существующий комментарий к таблице служит начальным содержимым страницы вики. После этого вики и комментарий становятся независимыми. Изменения в одном не обновляют другой.

Подробнее о комментариях к таблице см. раздел «Добавить комментарии к данным и AI-активам».

Limitations

  • Вики доступны только на планшетах. Вики для столбцов, схем, каталогов и других защищённых объектов не поддерживаются.
  • У каждой таблицы может быть только одна wiki.
  • Вики недоступны в регионах Azure для государственных организаций, Azure China или FedRAMP.
  • Последнее обновление: