DataWorksSQL代码编码原则和规范
编码原则
SQL代码的编码原则如下：
代码功能完善。
代码⾏清晰、整齐，代码⾏的整体层次分明、结构化强。
代码编写充分考虑执⾏速度最优的原则。
代码中需要添加必要的注释，以增强代码的可读性。
规范要求并⾮强制性约束开发⼈员的代码编写⾏为。实际应⽤中，在不违反常规要求的前提下，允许存在可以理解的偏差。
SQL代码中应⽤到的所有SQL关键字、保留字都需使⽤全⼤写或⼩写，例
如select/SELECT、from/FROM、where/WHERE、and/AND、or/OR、union/UNION、insert/INSERT、delete/DELETE、group/GROUP 、having/HAVING和count/COUNT等。不能使⽤⼤⼩
写混合的⽅式，例如Select或seLECT等⽅式。
4个空格为1个缩进量，所有的缩进均为1个缩进量的整数倍，按照代码层次对齐。
禁⽌使⽤select *操作，所有操作必须明确指定列名。
对应的括号要求在同⼀列的位置上。
SQL编码规范
SQL代码的编码规范如下：
代码头部
代码头部添加主题、功能描述、作者和⽇期等信息，并预留修改⽇志及标题栏，以便后续添加修改记录。注意每⾏不超过80个字符，模板如下。
-- MaxCompute(ODPS) SQL
--**************************************************************************
-- ** 所属主题: 交易
-- ** 功能描述: 交易退款分析
-- ** 创建者 : 有码
-- ** 创建⽇期: 20170616
-- ** 修改⽇志:
-- ** 修改⽇期修改⼈修改内容
-- yyyymmdd name comment
-- 20170831 ⽆码增加对biz_type=1234交易的判断
--**************************************************************************
字段排列要求
SELECT语句选择的字段按照每⾏1个字段的⽅式编排。
⾸个选择的字段与SELECT之间隔1个缩进量。
换⾏缩进2个缩进量后，添加逗号再输⼊其它字段名。
2个字段之间的逗号分隔符紧跟在第2个字段的前⾯。
AS语句应与相应的字段在同⼀⾏，多个字段的AS建议尽量对齐在同⼀列上。
INSERT⼦句排列要求
INSERT⼦句写在同⼀⾏，请勿换⾏。
SELECT⼦句排列要求
SELECT语句中所⽤到的from、where、group by、having、order by、join和union等⼦句，需要遵循如下要求：换⾏编写。
与相应的SELECT语句左对齐编排。
⼦句⾸个单词后添加2个缩进量，再编写后续的代码。
WHERE⼦句下的逻辑判断符and、or等，与WHERE左对齐编排。
超过2个缩进量长度的⼦句加1个空格后，再编写后续代码，例如order by和group by等。
运算符前后间隔要求
算术运算符、逻辑运算符前后要保留1个空格，并写在同⼀⾏（超过每⾏80个字符长度的限制除外）。
CASE语句的编写
CASE语句可以⽤于SELECT语句中对字段值进⾏判断取值的操作。CASE语句编排的规则如下：WHEN⼦语在CASE语句的同⼀⾏，并缩进1个缩进量后开始编写。
每个WHEN⼦句尽量在1⾏内编写，如果语句较长可以换⾏。
CASE语句必须包含ELSE⼦语，ELSE⼦句与WHEN⼦句对齐。
查询嵌套编写规范
在数据仓库系统ETL开发中经常使⽤⼦查询嵌套，其编写规范⽰例如下。
表别名定义约定
⼀旦在SELECT语句中给操作表定义了别名，在整个语句中对此表的引⽤都必须以别名替代，所以需要给所有的表添加别名。
表别名采⽤简单字符命名，建议按a、b、c、d…的顺序进⾏命名，并避免使⽤关键字。
多层次的嵌套⼦查询别名之前要体现层次关系，SQL语句的别名需要分层命名，从第1层次⾄第4层次，分别⽤P（Part） 、S（Segment）、 U（Unit） 和D（Detail）表⽰。您也可以⽤a、b、c、d来表⽰第1层次到第4层次。
对于同⼀层次的多个⼦句，在字母后加1、2、3、4……区分，并根据情况对表别名添加注释。insert语句字段顺序
SQL注释
每条SQL语句均应添加注释说明。
每条SQL语句的注释单独成⾏，并放在语句的前⾯。
字段注释紧跟在字段后⾯。
对不易理解的分⽀条件表达式添加注释。
对重要的计算添加注释，说明其功能。
过长的函数实现，应将其语句按实现的功能分段，添加注释进⾏说明。
添加常量及变量的注释时，应注释被保存值的含义（必选），合法取值的范围（可选）。
将⿏标放置对应SQL语句之后，使⽤Crtl+/或Cmd+/快捷键即可注释当前语句。如果您需要注释多⾏语句，则可以选中需要注释的语句，使⽤Crtl+/或Cmd+/批量完成注释。
说明
Windows系统仅⽀持使⽤Crtl+/快捷键注释SQL语句。
Mac系统仅⽀持使⽤Cmd+/快捷键注释SQL语句。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。