Описание БД (базы данных)

Утилита превращает выгрузку структуры базы данных в аккуратную документацию для базы знаний. Загружаешь файл со схемами, таблицами и полями (Excel или CSV) — получаешь готовую структуру папок: общую страницу со списком таблиц по схемам, а внутри — отдельный .md-файл на каждую таблицу с её полями. Удобно, когда нужно быстро задокументировать базу и положить это в вики или Confluence. Работает прямо в браузере, ничего устанавливать не нужно.

Как работает

  • Где работает: любой современный браузер (Chrome, Edge, Firefox, Safari). Ничего не устанавливается.
  • Откуда взять файл: прямо в утилите, на первом шаге, есть блок «Откуда взять файл» — там лежит готовый SQL-запрос для PostgreSQL и кнопка «Копировать запрос». Выполнить запрос → выгрузить результат в CSV → при желании открыть в Excel и сохранить как .xlsx, чтобы удобнее было фильтровать.
  • Что делать: загрузи файл (.xlsx, .xls или .csv). Выбери, какие колонки полей показывать. Утилита соберёт документацию и предложит скачать её архивом со структурой папок по схемам. Кнопка «Очистить» убирает файл и возвращает всё в начало.
  • Нюансы: ожидается выгрузка, где есть колонки «Схема», «Таблица», «Описание таблицы» и колонки полей (номер, имя, тип, описание, обязательность) — ровно то, что даёт запрос из блока «Откуда взять файл». Имя архива берётся от имени загруженного файла.

Что сохраняется между запусками

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

Приватность

Данные хранятся только на вашем компьютере, в интернет ничего не уходит. Файл читается и обрабатывается прямо в браузере; внешних библиотек и шрифтов из сети утилита не подгружает (разбор Excel встроен внутрь).

Скрипт для получения таблицы со схемами, таблицами, полями

SELECT
n.nspname AS "Схема",
c.relname AS "Таблица",
obj_description(c.oid) AS "Описание таблицы",
a.attnum AS "№ поля",
a.attname AS "Поле",
pg_catalog.format_type(a.atttypid, a.atttypmod) AS "Тип",
col_description(a.attrelid, a.attnum) AS "Описание поля",
CASE
WHEN a.attnotnull THEN 'NOT NULL'
ELSE 'NULL'
END AS "Обязательное"
FROM pg_attribute a
JOIN pg_class c ON a.attrelid = c.oid
JOIN pg_namespace n ON c.relnamespace = n.oid
WHERE
a.attnum > 0
AND NOT a.attisdropped
AND c.relkind = 'r'
AND n.nspname NOT IN ('pg_catalog', 'information_schema')
ORDER BY
n.nspname, c.relname, a.attnum;

Что нового

Накопительный раздел: новая версия добавляется сверху, прежние записи остаются.

Версия 2.0 — 12.08.2026

Добавлено:

  • Прямо в утилите, на первом шаге, появился блок «Откуда взять файл» с готовым SQL-запросом и кнопкой «Копировать запрос». Раньше запрос жил только на странице блога — скачавший файл не знал, откуда брать выгрузку.
  • Кнопка «Очистить» — убрать файл и начать заново.
  • Иконка на вкладке браузера.

Изменено:

  • Имя архива теперь берётся от имени загруженного файла, а не всегда одно и то же.
  • Уточнено описание того, что запоминается между запусками: раньше здесь обещалось больше, чем утилита делала.

Исправлено:

  • Скачивание архива могло не сработать в Firefox и Safari на больших файлах.
  • Если книга Excel устроена так, что лист с данными лежит не первым по внутреннему порядку файлов, разбирался не тот лист.
  • Кнопки отображались не тем шрифтом, что остальной текст.

Версия 1.0 — 08.07.2026

Первая версия.

Скачать