Como você documenta seu código de banco de dados para ver dependências entre objetos de banco de dados? [fechadas]
Eu quero escrever documentação sobre o meu projeto de estimação.
Eu tenho 30 tabelas e quase 50 visualizações e cerca de 30 funções (procedimentos armazenados) no meu banco de dados PostgreSQL.
Eu gostaria de ver onde as tabelas (quais vistas e quais funções) são usadas.
Eu gostaria de ver onde as visualizações (quais vistas e quais funções) são usadas.
Eu gostaria de ver se uma função é usada por outra função.
Eu também gostaria de escrever uma descrição de cada objeto (tabelas, visualizações e funções)
e uma breve descrição dos campos.
Logo, eu quero ser capaz de ver o que usar um objeto específico e quais objetos usam um objeto específico.
Eu pensei em usar um arquivo de texto e para cada objeto. Eu posso listar objetos que usam o atual e quais são usados pelo atual.
<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
Eu tenho medo que a minha documentação será dessincronizada rapidamente Imagine eu adicionar uma função f_cccc que chama f_aaaa e f_bbbb. Vou ter que modificar doc em f_aaaa e f_bbbb
Eu sei que a UML descreve relações sobre entidades (faz isso, certo ???). Mas eu quero algo simples e não quero seguir um treinamento de 75 horas ... E eu não tenho certeza se você pode ter um "link" entre as entidades e a função que eu quero.
Você tem algo para me sugerir?
Eu uso o PostgreSQL no Linux (Fedora). Se você propõe uma ferramenta que faz isso, ela deve ser compatível com o PostgreSQL :-)
Para minha documentação de código, eu uso o Doxygen.
Obrigado