Как вы документируете свой код базы данных, чтобы увидеть зависимости между объектами базы данных? [закрыто]
Я хочу написать документацию по моему любимому проекту.
У меня есть 30 таблиц и почти 50 представлений и около 30 функций (хранимых процедур) в моей базе данных PostgreSQL.
Я хотел бы видеть, где таблицы (какие представления и какие функции) используются.
Я хотел бы видеть, где представления (какие виды и какие функции) используются.
Я хотел бы увидеть, если функция используется другой функцией.
Я хотел бы также написать описание каждого объекта (таблицы, представления и функции)
и краткое описание полей.
Вкратце, я хочу иметь возможность увидеть, что использует конкретный объект и какие объекты используют конкретный объект.
Я думал использовать текстовый файл и для каждого объекта. Я мог бы перечислить объекты, которые используют текущий и какие из них используются текущим.
<pre>
Table aaaa
A short description
used by : view v_aaaa
id int primary key
name varchar(30) name of a...
================================
view v_aaaa
A short description
list of fields...
used by function f_aaaa
Depends on table aaaa
==============================
function f_aaaa
A short description
Parameters ( description, IN/OUT )
Depends on view v_aaaa
function fbbbb
==============================
function f_bbbb
A short description
Parameters
Called by function f_aaaa
Я боюсь, что моя документация будет быстро не синхронизирована Представьте, что я добавляю функцию f_cccc, которая вызывает f_aaaa и f_bbbb. Мне придется изменить документацию для f_aaaa и f_bbbb
Я знаю, что UML описывает отношения об объектах (это так, верно ???). Но я хочу чего-то простого и не хочу проходить 75-часовую тренировку ... И я не уверен, что у вас может быть «ссылка» между сущностями и функционировать, как я хочу.
У вас есть что предложить мне?
Я использую PostgreSQL на Linux (Fedora). Если вы предлагаете инструмент, который делает это, он должен быть совместим с PostgreSQL :-)
Для документации по коду я использую Doxygen.
Спасибо