51Testing软件测试论坛

标题: 数据库SQL编写规范 [打印本页]

作者: 测试积点老人    时间: 2019-1-11 14:45
标题: 数据库SQL编写规范

1 范围

本规范规定了SQL DQL和DML语言的编写总则,从书写格式归纳了SQL 书写的具体要求。


2 SQL编写总则

2.1 SQL语句应正确、规范、高效和最优。

2.2 应确保变量和参数的类型和大小与数据库中表数据列相匹配。

2.3 使用SELECT语句时,应指出列名,不应使用列的序号或者用“*”替代所有列名。(必须)

2.4 使用INSERT语句时,应指定插入的字段名,不应不指定字段名直接插入VALUES。

2.5 如果 SQL 语句连接多表时,应使用表的别名来引用列。


示例:

//正确的示例

  1. SELECT shopcatalog.catalogname, productinfo.producttitle
  2.   FROM t_e_shopcatalog shopcatalog
  3.   JOIN t_con_shopcatalog_product con
  4.     ON shopcatalog.catalogid = con.shopcatalogid
  5.   JOIN t_e_productinfo productinfo
  6. ON con.productid = productinfo.productid;
复制代码

2.6 SQL语句应避免对大表的全表扫描操作,对大表的操作应尽量使用索引。

2.7 SQL语句应避免不必要的排序。

2.8 SQL语句应避免删除全表的操作,如有需要请使用TRUNCATE方式。

2.9 应减少对表的更新。


示例:

//错误的书写方式

  1. UPDATE t_con_catalog2content
  2.    SET catalogid = REPLACE(catalogid, 'CNBJTW2', 'CNBJTW0');
  3. UPDATE t_con_catalog2content
  4.    SET contentid = REPLACE(contentid, 'CNBJTW2', 'CNBJTW0');
复制代码

//正确的书写方式

  1. UPDATE t_con_catalog2content
  2.    SET contentid = REPLACE(contentid, 'CNBJTW2', 'CNBJTW0'),
  3.        contentid = REPLACE(contentid, 'CNBJTW2', 'CNBJTW0');
复制代码

2.10 SQL语句尽可能避免多表联合复杂查询,穷举解析开销大。

2.11 应将SQL语句中的数据库函数、计算表达式等放置在等号右边。

2.12 应按照业务需要使用事务,同时应保持事务简短,避免大事务。

2.13 在同一语句中避免出现多个相同子查询,未避免此情况可以使用WITH语法。


示例:

//上面的表示with改写前语句;下面的表示with改下后语句

  1. SELECT MAX(b.ans)
  2.   FROM (SELECT a.questionid
  3.           FROM (SELECT a.paperid, a.questionid, a.questionsequence
  4.                   FROM t_con_paper_question a
  5.                  WHERE NOT EXISTS (SELECT b.questionid
  6.                           FROM t_con_paper_question b
  7.                          WHERE a.questionid = b.questionid
  8.                            AND b.childid IS NOT NULL)
  9.                 UNION
  10.                 SELECT a.paperid, a.childid AS questionid, a.questionsequence
  11.                   FROM t_con_paper_question a
  12.                  WHERE a.childid IS NOT NULL) a,
  13.                t_e_paper_publish c
  14.          WHERE a.paperid = c.paperid
  15.            AND c.publishid = $1) a,
  16.        (SELECT questionid, COUNT(DISTINCT sequenceno) AS ans
  17.           FROM (SELECT questionid, sequenceno
  18.                   FROM t_e_question_item
  19.                  WHERE childid = '0'
  20.                 UNION ALL
  21.                 SELECT childid questionid, sequenceno
  22.                   FROM t_e_question_item
  23.                  WHERE childid <> '0') gg
  24.          GROUP BY questionid) b
  25. WHERE a.questionid = b.questionid;
  26. WITH question AS
  27. (SELECT a.questionid, a.childid
  28.     FROM t_con_paper_question a, t_e_paper_publish c
  29.    WHERE a.paperid = c.paperid
  30.      AND c.publishid = 'CNGDLG0200000001297')
  31. SELECT MAX(b.ans)
  32.   FROM (SELECT questionid, COUNT(DISTINCT sequenceno) AS ans
  33.           FROM (SELECT questionid, sequenceno
  34.                   FROM t_e_question_item
  35.                  WHERE childid = '0'
  36.                    AND questionid IN
  37.                        (SELECT questionid FROM question WHERE childid IS NULL)
  38.                 UNION ALL
  39.                 SELECT childid questionid, sequenceno
  40.                   FROM t_e_question_item
  41.                  WHERE childid <> '0'
  42.                    AND childid IN
  43.                        (SELECT childid FROM question WHERE childid IS NOT NULL)) gg
  44.          GROUP BY questionid) b;
复制代码

2.14 SQL语句应避免频繁引起数据库事务回滚。

2.15 外连接时,注意被连接表条件的位置。


示例:

//上面的表示书写错误;下面的表示书写正确

  1. SELECT a.status, b.content
  2.   FROM t_e_message_delivery_status a
  3.   LEFT JOIN t_e_us_message b
  4.     ON a.messageid = b.messageid
  5. WHERE a.status = '1'
  6.    AND b.messagetype IN ('7', '10')
  7.    AND a.recipienttype = '1'
  8.    AND b.recipienttype IN ('1', '11')
  9.    AND a.readtime IS NULL;
  10. SELECT a.status, b.content
  11.   FROM t_e_message_delivery_status a
  12.   LEFT JOIN t_e_us_message b
  13.     ON a.messageid = b.messageid
  14.    AND b.messagetype IN ('7', '10')
  15.    AND b.recipienttype IN ('1', '11')
  16. WHERE a.status = '1'
  17.    AND a.recipienttype = '1'
  18.    AND a.readtime IS NULL;
复制代码

3 SQL书写规则

3.1 SQL语句的大小写

3.1.1 SQL语句中出现的所有表名、表别名、字段名、序列名、视图等数据库对象都应小写。

3.1.2 SQL 语句中出现的系统保留字、内置函数名、SQL保留字等都应大写。


3.3 SQL构建

3.3.1 如果一行有多列并超过80个字符,基于列对齐原则,应采用下行缩进。

3.3.2 缩进应为4个字符。

3.3.3 同层次的SQL语句缩进应保持一致。

3.3.4 SQL 文中不应出现空行。


3.4 SQL 书写应遵循以下空格规则。

3.4.1 SQL语句内的算术运算符、逻辑运算符(AND、OR、NOT)、 比较运算符(=、<=、>=、>、<、<>、!=、BETWEEN AND)、IN、LIKE等运算符前后都应加一空格。

3.4.2 SQL 语句中逗号后应加一空格。


3.5 SQL 语句的注释。

3.5.1 对较为复杂的 SQL 语句应注释,并说明算法和功能。

3.5.2 注释应单独成行,并放在语句前面。

3.5.3 应对不易理解的分支条件表达式加注释。

3.5.4 对重要的计算应说明其功能。

3.5.5 过长的函数实现,应将其语句按实现的功能分段加以概括性说明。

3.5.6 对常量及变量注释时,应注释被保存值的含义,宜包括合法取值的范围。

3.5.7 应可采用多行注释。(/* */ 方式)。


3.6 函数几点约束。

3.6.1 函数参数使用显示定义。

3.6.2 使用$BODY$包裹代码块。

3.6.3 函数必须注释创建人、创建时间、功能、参数说明及修改信息等。

3.6.4 如果是定时函数则必须记录运行日志。







欢迎光临 51Testing软件测试论坛 (http://bbs.51testing.com/) Powered by Discuz! X3.2