Wie dokumentieren Sie Ihren Datenbankcode, um Abhängigkeiten zwischen Datenbankobjekten zu erkennen? [geschlossen]

Ich möchte Unterlagen zu meinem Lieblingsprojekt schreiben.

Ich habe 30 Tabellen und fast 50 Ansichten und ungefähr 30 Funktionen (gespeicherte Prozeduren) in meiner PostgreSQL-Datenbank.

Ich möchte sehen, wo Tabellen (welche Ansichten und welche Funktionen) verwendet werden.

Ich möchte sehen, wo Ansichten (welche Ansichten und welche Funktionen) verwendet werden.

Ich möchte sehen, ob eine Funktion von einer anderen Funktion verwendet wird.

Ich möchte auch eine Beschreibung der einzelnen Objekte (Tabellen, Ansichten und Funktionen) schreiben

und eine kurze Beschreibung der Felder.

In Kürze möchte ich in der Lage sein zu sehen, welche Verwendung ein bestimmtes Objekt und welche Objekte ein bestimmtes Objekt verwenden.

Ich dachte, eine Textdatei und für jedes Objekt zu verwenden. Ich könnte Objekte auflisten, die das aktuelle verwenden und welche vom aktuellen verwendet werden.

<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

Ich fürchte, meine Dokumentation wird schnell nicht synchronisiert. Stellen Sie sich vor, ich füge eine Funktion f_cccc hinzu, die f_aaaa und f_bbbb aufruft. Ich muss doc auf f_aaaa und f_bbbb ändern

Ich weiß, dass UML Beziehungen über Entitäten beschreibt (das macht es, richtig ???). Aber ich möchte etwas Einfaches und möchte kein 75-Stunden-Training absolvieren ... Und ich bin mir nicht sicher, ob Sie eine "Verbindung" zwischen Entitäten und Funktionen herstellen können, wie ich es möchte.

Haben Sie etwas, das Sie mir vorschlagen können?

Ich benutze PostgreSQL unter Linux (Fedora). Wenn Sie ein Tool vorschlagen, das dies tut, muss es mit PostgreSQL kompatibel sein :-)

Für meine Codedokumentation verwende ich Doxygen.

Vielen Dank

Antworten auf die Frage(5)

Ihre Antwort auf die Frage