Документирование схемы

функциональный

Генерация Markdown-документации по схеме базы данных, которую можно сразу положить в репозиторий или вики.

Создать Markdown документацию по схеме базы данных за один шаг: выберите действие, укажите, куда сохранить, готово. Здесь намеренно нечего настраивать: документ строится из модели схемы, уже загруженной в SQLly для IntelliSense, поэтому не требуется дополнительный запрос к серверу, и он в точности отражает то, что знает приложение.

Выходные данные — это словарь данных с шапкой из подключения и базы данных, разбитый на Таблицы, Представления, Процедуры, Функции, и Другие объекты. Каждая таблица получает сетку столбцов: имя, тип, допустимость NULL, значение по умолчанию и аннотации ключей (первичный ключ, identity, FK → целевой) - плюс внешние ключи списком; у процедур и функций — их сигнатуры параметров и типы возвращаемых значений. Очень большие схемы автоматически разбиваются на индексный файл и по одному файлу на схему, чтобы результат оставался удобным для навигации в репозитории или вики.

SQLly
Вывод Document Schema в SQLly (Markdown)Вывод Document Schema в SQLly (Markdown)
Документирование схемы: структура базы данных в виде документации в формате Markdown, готовой к сохранению.

Создание словаря данных

  1. Подключитесь и дайте модели схемы время на загрузку (это та же модель, что обеспечивает автодополнение). Если она ещё не загрузилась, SQLly сообщит об этом в строке состояния и ничего не сделает.
  2. Щёлкните правой кнопкой мыши по базе данных в обозревателе и выберите Схема › Документировать схему (Markdown)...или выполните Документирование схемы (Markdown)... из палитры команд. При открытии из проводника эта база данных сначала становится активной.
  3. Открывается диалог сохранения с schema-docs.md предложенным. Выберите папку и имя.
  4. Строка состояния подтверждает, где оно было сохранено и сколько файлов было записано при разделении схемы.

Как выглядит Markdown

Объекты сортируются по разделу, а затем по имени. Небольшая схема создаёт что-то вроде этого:

# Data Dictionary — Shop / sales

Generated by SQLLY from the loaded schema model. 2 objects.

## Tables

### dbo.Orders

| Column | Type | Nullable | Default | Key |
|---|---|---|---|---|
| OrderId | int | no |  | PK, identity |
| CustomerId | int | no |  | FK → dbo.Customers |
| Total | decimal | yes |  |  |

- Foreign key (CustomerId) → dbo.Customers (CustomerId)

## Procedures

### dbo.PlaceOrder

| Parameter | Type | Mode | Default |
|---|---|---|---|
| @CustomerId | int | in |  |
  • Таблицы - одна строка на столбец. Допускает NULL является yes, no, или ? когда модель не знает. Ячейка Ключ объединяет PK, FK → target, и identity.
  • Представления - сетку «Столбец / Тип», или Столбцы не записаны в модели схемы когда модель знает только имя представления.
  • Процедуры и функции - сетку «Параметр / Тип / Режим / Значение по умолчанию» (режим — in, out, или in/out), Нет параметров. когда их нет, и Возвращает: строка для функций.
  • Другие объекты - синонимы показывают свою цель; все остальное перечислено по имени с Структурные сведения не записаны.

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

Крупные схемы

До 2000 объектов попадают в один файл с указанным вами именем. Сверх этого SQLly записывает этот файл как индекс с перечнем всех схем, количеством объектов и ссылкой, плюс отдельный файл для каждой схемы рядом с ним, названный по вашему файлу: schema-docs.sales.md, schema-docs.audit.md, и так далее. Имена схем делаются безопасными для имён файлов, а схемам, которые могли бы конфликтовать, добавляется числовой суффикс вместо перезаписи друг друга. Ничего не обрезается.

Что нужно знать

  • Это работает с любым движком, к которому SQLly подключается, потому что он считывает собственную модель SQLly, а не каталог конкретного движка.
  • Документ настолько же полон, насколько полна загруженная модель. Если модель не записала столбцы представления, документ так и говорит, а не догадывается.
  • Сохранение записывает файл напрямую; существующие файлы с такими же именами заменяются.
  • Сохранение в файл недоступно в предпросмотре в браузере; используйте настольное приложение.