在 MS SQL 数据库中记录大量相互关联的存储过程：什么工具或格式？

Question

我希望这是一个比“阅读一本 1000 页的书”更短答案的问题，但是，如果这是真实情况，那么就用它来打击我。

我不是真正的 DBA，我是一名软件开发人员，我意识到我们需要 DBA，但我工作的商店的 DBA 为零。然而，我们的 MS SQL 数据库设计包括几个核心存储过程，是一个巨大的混乱。存储过程很慢，我们怀疑它们有错误，但我们甚至不知道它们应该如何工作，所以我们不知道如何修复它们。

作为开始，我决定我们将记录它应该如何工作，然后我们将开始单元测试，并构建一组单元测试来帮助证明存储过程确实可以工作。它们执行的逻辑是我们应用程序的关键部分，可以说，它是我们公司主要产品的“皇冠上的明珠”，它的工作方式完全没有记录。

我正在寻找专业 DBA 可能希望现有的特定技术文档，或者他们可能会自己编写（如果必须），以了解相互调用的巨大存储过程网络。

1. 记录大型存储过程的常用格式是什么？每个输入参数的预期值的描述（即“前置条件”、“后置条件”，即布尔参数在打开或关闭时会发生什么变化等？）

2. 人们通常如何记录它？仅 SQL 注释？特定于目的的外部工具？外部“文档”？除了 MS SQL Management Studio 之外，我们没有 SQL 工具，但我们想知道是否有一种工具可以更好地理解、记录和测试我们的环境。也许这是问我问题的更好方式；我需要什么工具来解决我们的烂摊子？

我们的目标是能够：

A. 使用我们生成的文档或我们添加到环境中的任何工具来帮助理解过程应该如何工作，然后我们可以继续为存储过程创建单元测试覆盖率。

B. 向客户端应用程序开发人员展示如何正确调用这些复杂的存储过程。

C. 单元测试我们的存储过程。

Answer 1

关于文档最重要的是它对您有意义。没有真正标准的方法来做到这一点。

如果您有大量相互连接的存储过程，从每个过程都有一个对象的 Visio 图表开始，那么它们之间的链接以便您可以跟踪过程之间的情况可能是一个很好的开始。