SQL样式指南 SQL Style Guide.docx
《SQL样式指南 SQL Style Guide.docx》由会员分享,可在线阅读,更多相关《SQL样式指南 SQL Style Guide.docx(11页珍藏版)》请在文库网上搜索。
1、SQL样式指南 SQL Style GuideOverview 综述你可以直接使用这些指导方针,或者fork后创建自己的版本最重要的是选择一套方针并严格遵守它。欢迎通过提交issue或pull request来提交建议或修复bug。为了让阅读了Joe Celko的SQL ProgrammingStyle的团队能更容易采用这套规则, 这套原则被设计成与该书的兼容的形式。该指南在某些领域严格一些,在另一些领域松懈一些。 当然该指南比Celko的书更简洁一些,因为Celko的书包含了一些趣闻和每一条原则后的理由。将该文档的Markdown format格式添加到项目代码库中或将该页面的链接发送给所有
2、项目的参与者要比传阅实体书容易得多。Simon Holywell所著的SQL样式指南以署名-相同方式共享 4.0 国际协议发布,改编自sqlstyle.guide。General 一般原则Do 应该做的事情 使用一致的、叙述性的名称。 灵活使用空格和缩进来增强可读性。 存储符合ISO-8601标准的日期格式(YYYY-MM-DD HH:MM:SS.SSSSS)。 最好使用标准SQL函数而不是特定供应商的函数以提高可移植性。 保证代码简洁明了并消除多余的SQL比如非必要的引号或括号,或者可以推导出的多余WHERE语句。 必要时在SQL代码中加入注释。优先使用C语言式的以/*开始以*/结束的块注释
3、,或使用以-开始的行注释。Avoid 应避免的事情 驼峰命名法它不适合快速扫描。 描述性的前缀或匈牙利命名法比如sp_或tbl。 复数形式尽量使用更自然的集合术语。比如,用“staff”替代“employees”,或用“people”替代“individuals”。 需要引用号的标识符如果你必须使用这样的标识符,最好坚持用SQL92的双引号来提高可移植性。 面向对象编程的原则不该应用到结构化查询语言或数据库结构上。Naming conventions 命名惯例General 一般原则 保证名字独一无二且不是保留字。 保证名字长度不超过30个字节。 名字要以字母开头,不能以下划线结尾。 只在名字
4、中使用字母、数字和下划线。 不要在名字中出现连续下划线这样很难辨认。 在名字中需要空格的地方用下划线代替。 尽量避免使用缩写词。使用时一定确定这个缩写简明易懂。Tables 表名 用集群名称,或在不那么理想的情况下,复数形式。如staff和employees。 不要使用类似tbl或其他的描述性的前缀或匈牙利命名法。 表不应该同它的列同名,反之亦然。 尽量避免连接两个表的名字作为关系表(relationship table)的名字。与其使用cars_mechanics做表名不如使用services。Columns 列名 总是使用单数形式。 避免直接使用id做表的主标识符。 避免列名同表名同名,反
5、之亦然。 总是使用小写字母,除非是特殊情况,如专有名词。Aliasing or correlations 别名与关联名 应该与它们别名的对象或与它们代表的表达式相关联。 一般来说,关联名应该是对象名的第一个字母。 如果已经有相同的关联名了,那么在关联名后加一个数字。 总是加上AS关键字,因为这样的显示声明易于阅读。 为计算出的数据命名时,用一个将这条数据存在表里时会使用的列名。Stored procedures 过程名 名字一定要包含动词。 不要附加sp_或任何其他这样的叙述性前缀或使用匈牙利表示法。Uniform suffix 统一的后缀下列后缀有统一的意义,能保证SQL代码更容易被理解。在
6、合适的时候使用正确的后缀。 _id独一无二的标识符,如主键。 _status标识值或任何表示状态的值,比如publication_status。 _total总和或某些值的和。 _num表示该域包含数值。 _name表示名字。 _seq包含一系列数值。 _date表示该列包含日期。 _tally计数值。 _size大小,如文件大小或服装大小。 _addr地址,有形的或无形的,如ip_addrQuery syntax 查询语句Reserved words 保留字保留字总是大写,如SELECT和WHERE。最好使用保留字的全称而不是简写,用ABSOLUTE而不用ABS。当标准ANSI SQL关键字
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- SQL样式指南 SQL Style Guide 样式 指南