9.2.2 DBDoc Model Reporting — MySQL Workbench

9.2.2 Создание отчета модели DBDoc

Диалог DBDoc - Создание отчета модели открывается путем открытия модели, выбора Модель из меню, а затем DBDoc - Создание отчета модели.

Примечание

Данная функция доступна только в коммерческих редакциях MySQL Workbench.

Используйте диалог DBDoc - Создание отчета модели для настройки параметров создания документации для ваших баз данных. Например, на рисунке показан диалог с выбранным HTML Detailed Frames и шаблоном стиля Vibrant.

Рисунок 9.19 Параметры создания отчета модели DBDoc

Content is described in the surrounding text.

Вы можете выбрать один из четырех доступных шаблонов для генерации отчета:

HTML Basic Frames: Документация модели в формате HTML с использованием фреймов.
HTML Basic Single Page: Документация HTML на одной странице без использования фреймов.
HTML Detailed Frames: Подробная документация HTML с использованием фреймов.
Text Basic: Документация в формате текстового файла.

При нажатии на шаблон справа отображается предварительный просмотр. Для шаблона HTML Basic Frames вы можете выбрать либо вариант Colorful, либо вариант Restrained Colors из списка Стиль. Шаблон HTML Basic Single Page предлагает только стиль Colorful. Шаблон HTML Detailed Frames предлагает стиль Vibrant, а также более спокойный стиль Coated. Шаблон Text Basic предлагает только стиль Fixed Size Font.

В блоке Основные параметры выберите заголовок отчета и каталог вывода для файлов отчета.

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

~: Домашний каталог пользователя. Доступно только в версиях для Linux и macOS.
%desktopfolder%: Рабочий стол пользователя.

%documentsfolder%: Папка Документы пользователя. Таблица ниже показывает типичные значения для распространённых платформ.

Платформа	Типичная папка Документы по умолчанию
Windows	`C:\Users\user_name\My Documents`
Linux	`~/Documents`
macOS	`Users/user_name/Documents`

%date%: Дата в формате ГГГГ-ММ-ДД.
%time%: Время в формате ЧЧММ.
%year%: Год в формате ГГГГ.
%month%: Месяц в формате ММ. Январь - 01, Декабрь - 12.
%monthname%: Название месяца, а не число.
%day%: Номер дня в формате ДД. Например, 12-е число - 12.

Также можно выбрать параметры содержимого:

Столбцы таблицы вывода: Отобразить все столбцы.
Индексы таблицы вывода: Отобразить все индексы.
Внешние ключи вывода: Отобразить все внешние ключи.
Ссылки по внешним ключам вывода: Отобразить таблицы, к которым ссылаются внешние ключи.
Включить DDL-код для объектов: Генерирует DDL-код.

Нажатие кнопки Сгенерировать создает каталог, определенный в текстовом поле Каталог вывода. Если вы выбрали HTML Basic Frames, в этом каталоге вы найдете следующие файлы:

basic.css: Стили для страницы overview.html.
index.html: Главная страница.
overview.html: Обзор модели, ссылки для навигации, отображаемые в боковой панели.
restrained.css: Файл CSS, используемый при выборе стиля Restrained Colors.
table_details.html: Главный фрейм отчета модели.

Выбор варианта HTML Basic Single Page создает стили и файл index.html.

Выбор варианта HTML Detailed Frames создает следующие файлы:

Для получения дополнительной информации о создании пользовательских шаблонов, см. Раздел 9.7, «Настройка шаблонов DBDoc для отчетов о модели».

© 2025 Oracle
Licensed under the GPLv2 License.
https://docs.oracle.com/cd/E17952_01/workbench-en/wb-model-reporting.html