我想写一份关于我的宠物项目的文档。
我有30个表,近50个视图和约30个函数(存储过程)在我的PostgreSQL数据库中。
我想知道哪些表(哪些视图和哪些函数)被使用了。
我想知道哪些视图(哪些视图和哪些函数)被使用了。
我想知道一个函数是否被另一个函数使用。
我还想为每个对象(表、视图和函数)编写描述以及字段的简短描述。
简而言之,我希望能够看到特定对象的使用情况以及使用特定对象的对象。
我考虑使用一个文本文件来列出每个对象,并列出使用当前对象的对象以及被当前对象使用的对象。
我有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_aaaa和f_bbbb的函数f_cccc。我将不得不修改f_aaaa和f_bbbb的文档。
我知道UML描述实体之间的关系(它确实是这样吗?)。但我想要简单的东西,我不想参加75小时的培训...而且我不确定你是否可以像我想的那样在实体和函数之间建立“链接”。
你有什么建议吗?
我在Linux(Fedora)上使用PostgreSQL。如果您提供一个这样做的工具,它必须与PostgreSQL兼容:-)
对于我的代码文档,我使用Doxygen。
谢谢