首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >SQL编码标准

问SQL编码标准
EN

Stack Overflow用户
提问于 2013-06-09 01:33:45
回答 3查看 1.4K关注 0票数 2

最近,我开始在一家新公司担任报告分析师。我有软件开发经验,部门经理让我为我们的SQL提出一些标准,所以我正在向StackOverFlow社区征求意见。

我认为,我们需要为每份报告提供一种叙述,确切地说明报告应该提供什么信息,以及它将如何有用地管理这一过程。这需要一些流程文档(例如账单流程的工作原理),而我们也没有这些文档。我认为在数据库查询策略不明显的情况下,我们需要一条语句来解释查询用来检索数据的策略。最后,我们应该有足够的资源,以便可以将报告交给新员工,并且他们拥有运行、维护和修改报告所需的内容。

然后是SQL编码标准的问题-注释标题应该包括什么(作者,日期,更改历史...?),以及结构化缩进以提高清晰度。我们是否应该对这些事情进行更改控制,包括代码审查和文档化测试?

EN

回答 3

Stack Overflow用户

发布于 2013-06-09 01:47:56

与其使用头文件,为什么不使用源代码控制db schema和所有的存储过程、视图、udf等等?

这样,您就不必手动维护元数据,随着时间的推移,随着人们忘记更新元数据,元数据将不可避免地丢失完整性。

http://msdn.microsoft.com/en-us/library/ms173550(v=sql.105).aspx

票数 4
EN

Stack Overflow用户

发布于 2013-06-09 01:54:02

我仔细查看了您传递的查询,我所能说的就是“哇!”你肯定有你的工作等着你。

像这样的过程几乎没有注释,常量内嵌在代码中,全部大写,以及子selects的子selects,维护起来简直是噩梦。我要说的是,不管是谁写的这篇文章,他在那里都有很好的工作保障。

你关于头块的建议很好。我希望有以下元素:姓名;原始作者;原始日期;目的;预期输入;预期输出;以及完整的变更历史记录,包括:作者;变更日期;变更目的。

当然,这些应该是版本化的。随着现代源代码控制系统的出现,这应该不是问题。

其他必须做的事情是描述性注释,以及代码的缩进。有很多优秀的编辑器可以自动缩进,所以没有什么好的理由不这样做。

您提到了代码审查和文档化测试。这些也是很好的实践,但要想让它们有效,你需要有一支乐于接受建设性批评的员工。

感谢你的主动出击。我感觉到从这里开始你还有很长的路要走!

票数 0
EN

Stack Overflow用户

发布于 2013-06-09 02:32:09

软件可以解决您的问题(例如,TFS),但由于某种原因,您无法在您的环境中使用它,这种情况并不少见。有一些方法可以滥用源代码控制软件--比如流氓开发人员开始从“他的”沙箱中运行所有报告。而且,版本控制软件并不能解决您的所有问题。例如,它对代码中的注释或命名约定没有什么可说的。

下面是一些帮助数据库软件维护的“标准”:

当版本控制软件不被允许时,我有一个描述变更历史的注释块。看起来是这样的:

代码语言:javascript
复制
/*
 * GSL 2013-06-08   Modified foo at Jean's request
 * GSL 2013-06-01   Created
 */

这适用于视图、存储过程和用户定义函数。如果我注意到一个没有评论的变化,那么我会使用“在电子邮件中或当面尴尬”的方法来诱使遵守。

以下内容与版本控制无关。

命名约定:不同表中的相同内容总是具有相同的名称。甚至是主键。通常,我用复数命名一个表,然后删除"s“并添加"id”作为主键。

列约定:几乎所有的表都有一个主键(表名的单数形式,后面加上"id“)以及CreatedAt和CreatedBy列。后者回答的问题是:“最后做的事情是什么?”和“谁会被扣篮?”

列前缀:对于源列来自数据库外部的表,我使用前缀来表示它们来自何处。像jl_telephonenumber这样的东西,表示来自简的列表中的内容的电话号码。

捕获错误:我将存储过程包装在try/catch块中,并尝试在本地处理错误。通常,存储过程接受status和ErrMsg输出变量,因此我可以将状态信息传递回调用者。而且,调用者总是检查状态。

缩进:这是宗教的,而我有我的宗教。用一种非常特殊的缩排风格写一本书有一定的好处,我就是用这种缩排风格。我有足够的经验,知道一种特定的风格不可能强加给每个人。但是,代码必须清晰,并且必须能够清楚地将子查询块彼此区分开来。

表别名:避免使用a、b、c、x、y、z。别名应该是有问题的表的缩写。

最后(现在),如果你真的想保证代码的准确性,那么你应该进行代码审查。这将是一个大约60分钟的会议,每周一次,会议将通过一份报告,并讨论报告的编码方面。很可能,通过指出现有报告中的缺陷,这些审查将被证明是非常有价值的。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/17002086

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档