sql - 如何记录数据库

Question

关闭。这个问题需要多问 focused 。目前不接受答案。

---

想要改进此问题吗？更新问题，使其仅关注一个问题 editing this post .

已关闭 8 年前。

此帖子于去年编辑并提交审核，但未能重新打开帖子:

原始关闭原因未解决

Improve this question

(注意:我意识到这接近 How do you document your database structure? ，但我不认为它是相同的。)

我已经开始在一个数据库中工作，该数据库实际上有数百个表和 View ，所有这些都具有神秘的名称，元音很少，并且没有文档。他们也不允许对数据库模式进行无端的更改，除了我自己机器上的测试数据库(它会被吹走并定期重新创建)之外，我也不能接触任何数据库，因此我无法添加对任何人有帮助的注释。

我尝试使用“Toad”创建 ER 图，但在让它连续运行 48 小时后，它仍然没有产生任何可见的东西，我需要恢复我的计算机。我正在与其他一些新员工交谈，我们都建议，每当我们对某个特定表格或其某些列的含义感到困惑时，我们应该在开发人员 wiki 中更新它。

那么有什么好的方法可以做到这一点呢？只需列出表/ View 及其列并在我们进行时填写它们？我手头上的基本工具是 Toad、Oracle 的“SQL Developer”、MS Office 和 Visio。

Answer 1

根据我的经验，ER(或 UML)图并不是最有用的工件 - 由于有大量表格，图表(尤其是逆向工程图表)通常是一个大而复杂的困惑，没有人从中学到任何东西。

就我而言，一些好的人类可读文档(可能辅以系统较小部分的图表)将为您带来最大的帮助。对于每个表，这将包括:

• 描述表格的含义及其功能使用方式(在用户界面等中)
• 描述每个属性的含义(如果不明显)
• 解释此表与其他表之间的关系(外键)，反之亦然
• 其他限制和/或触发器的说明
• 对涉及表的主要 View 和过程的补充说明(如果尚未详细记录)

对于上述所有内容，不要为了记录而记录 - 重述显而易见的内容的文档只会妨碍人们。相反，专注于最初让你感到困惑的事情，并花几分钟写出真正清晰、简洁的解释。这将帮助您彻底思考，并且将大量帮助第一次接触这些表的其他开发人员。

正如其他人提到的，有多种工具可以帮助您管理此问题，例如 Enterprise Architect , Red Gate SQL Doc以及来自各个供应商的内置工具。但是，虽然工具支持很有帮助(在较大的数据库中甚至至关重要)，但努力理解和解释数据库的概念模型才是真正的胜利。从这个角度来看，您甚至可以在文本文件中进行操作(尽管以 Wiki 形式进行操作将允许多个人协作逐步添加到该文档中 - 因此，每次有人弄清楚某些内容时，他们都可以将其添加到不断增长的文档中立即获得文档)。