良好的编码习惯可以减少出问题的几率和后期代码维护的成本
基本要求
- 脚本文件名称使用小写,单词与单词间使用下划线分割,最好对应于操作的表名
- 脚本采用 UTF-8编码, UNIX格式
- 脚本必须写好基本注释信息(如: 脚本功能,加载时机频率,开发人员…)
编写规范
注释编写
SQL脚本中无论单行、多行注释均用 –
标识,不使用块状注释 / /
1 | -- 脚本名称: demo.sql |
字段排列
- 每个查询字段独占一行
- 分割字段的逗号置于字段名称之前
- 查询字段写好注释
1 | select field1 -- 字段1 |
子句排列
同一级别的子句要对齐
1 | select a.field1 -- 字段1 |
子句查询嵌套
子句嵌套编排做好层次分明
1 | select a.field1 -- 字段1 |
字段别名
- 如查询字段的名称与目标表字段名称不一致,则使用
AS
为字段命别名 - 若查询字段或表达式过长,则
AS
最好分行对齐
1 | insert into test.tgt ( -- 目标表 |
表别名
多表嵌套查询需体现层次结构,可为表命别名。使用字母 a-z标明层次, 同一层次间使用数字标明序号
1 | select a1.field1 -- 字段1 |
特殊表命名规范
- 历史表: 以h结尾
- 临时表: 以tmp结尾
- 备份表: 以8位备份日期结尾