大数据开发SQL代码编码原则和规范

简介: 这段SQL编码原则强调代码的功能完整性、清晰度、执行效率及可读性,通过统一关键词大小写、缩进量以及禁止使用模糊操作如select *等手段提升代码质量。此外,SQL编码规范还详细规定了代码头部信息、字段与子句排列、运算符前后间隔、CASE语句编写、查询嵌套、表别名定义以及SQL注释的具体要求,确保代码的一致性和维护性。

编码原则
SQL代码的编码原则如下:

代码功能完善。代码效果参考:http://www.603393.com/sitemap/post.html

代码行清晰、整齐,代码行的整体层次分明、结构化强。

代码编写充分考虑执行速度最优的原则。

代码中需要添加必要的注释,以增强代码的可读性。

规范要求并非强制性约束开发人员的代码编写行为。实际应用中,在不违反常规要求的前提下,允许存在可以理解的偏差。

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建议尽量对齐在同一列上。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行内编写,如果语句较长可以换行。else子句

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……区分,并根据情况对表别名添加注释。别名

SQL注释

每条SQL语句均应添加注释说明。

每条SQL语句的注释单独成行,并放在语句的前面。

字段注释紧跟在字段后面。

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

对重要的计算添加注释,说明其功能。

过长的函数实现,应将其语句按实现的功能分段,添加注释进行说明。

添加常量及变量的注释时,应注释被保存值的含义(必选),合法取值的范围(可选)。

将鼠标放置对应SQL语句之后,使用Ctrl+/或Cmd+/快捷键即可注释当前语句。如果您需要注释多行语句,则可以选中需要注释的语句,使用Ctrl+/或Cmd+/批量完成注释。

相关实践学习
基于MaxCompute的热门话题分析
Apsara Clouder大数据专项技能认证配套课程:基于MaxCompute的热门话题分析
相关文章
|
3月前
|
SQL 存储 分布式计算
【万字长文,建议收藏】《高性能ODPS SQL章法》——用古人智慧驾驭大数据战场
本文旨在帮助非专业数据研发但是有高频ODPS使用需求的同学们(如数分、算法、产品等)能够快速上手ODPS查询优化,实现高性能查数看数,避免日常工作中因SQL任务卡壳、失败等情况造成的工作产出delay甚至集群资源稳定性问题。
1094 36
【万字长文,建议收藏】《高性能ODPS SQL章法》——用古人智慧驾驭大数据战场
|
7月前
|
负载均衡 算法 关系型数据库
大数据大厂之MySQL数据库课程设计:揭秘MySQL集群架构负载均衡核心算法:从理论到Java代码实战,让你的数据库性能飙升!
本文聚焦 MySQL 集群架构中的负载均衡算法,阐述其重要性。详细介绍轮询、加权轮询、最少连接、加权最少连接、随机、源地址哈希等常用算法,分析各自优缺点及适用场景。并提供 Java 语言代码实现示例,助力直观理解。文章结构清晰,语言通俗易懂,对理解和应用负载均衡算法具有实用价值和参考价值。
大数据大厂之MySQL数据库课程设计:揭秘MySQL集群架构负载均衡核心算法:从理论到Java代码实战,让你的数据库性能飙升!
|
3月前
|
存储 并行计算 算法
【动态多目标优化算法】基于自适应启动策略的混合交叉动态约束多目标优化算法(MC-DCMOEA)求解CEC2023研究(Matlab代码实现)
【动态多目标优化算法】基于自适应启动策略的混合交叉动态约束多目标优化算法(MC-DCMOEA)求解CEC2023研究(Matlab代码实现)
202 4
|
9月前
|
SQL 自然语言处理 数据库
【Azure Developer】分享两段Python代码处理表格(CSV格式)数据 : 根据每列的内容生成SQL语句
本文介绍了使用Python Pandas处理数据收集任务中格式不统一的问题。针对两种情况:服务名对应多人拥有状态(1/0表示),以及服务名与人名重复列的情况,分别采用双层for循环和字典数据结构实现数据转换,最终生成Name对应的Services列表(逗号分隔)。此方法高效解决大量数据的人工处理难题,减少错误并提升效率。文中附带代码示例及执行结果截图,便于理解和实践。
242 4
|
4月前
|
SQL 分布式计算 大数据
SparkSQL 入门指南:小白也能懂的大数据 SQL 处理神器
在大数据处理的领域,SparkSQL 是一种非常强大的工具,它可以让开发人员以 SQL 的方式处理和查询大规模数据集。SparkSQL 集成了 SQL 查询引擎和 Spark 的分布式计算引擎,使得我们可以在分布式环境下执行 SQL 查询,并能利用 Spark 的强大计算能力进行数据分析。
|
6月前
|
机器学习/深度学习 数据挖掘 大数据
大数据集特征工程实践:将54万样本预测误差降低68%的技术路径与代码实现详解
本文通过实际案例演示特征工程在回归任务中的应用效果,重点分析包含数值型、分类型和时间序列特征的大规模表格数据集的处理方法。
231 0
大数据集特征工程实践:将54万样本预测误差降低68%的技术路径与代码实现详解
|
6月前
|
SQL 人工智能 分布式计算
别再只会写SQL了!这五个大数据趋势正在悄悄改变行业格局
别再只会写SQL了!这五个大数据趋势正在悄悄改变行业格局
133 0
|
8月前
|
SQL 关系型数据库 MySQL
大数据新视界--大数据大厂之MySQL数据库课程设计:MySQL 数据库 SQL 语句调优方法详解(2-1)
本文深入介绍 MySQL 数据库 SQL 语句调优方法。涵盖分析查询执行计划,如使用 EXPLAIN 命令及理解关键指标;优化查询语句结构,包括避免子查询、减少函数使用、合理用索引列及避免 “OR”。还介绍了索引类型知识,如 B 树索引、哈希索引等。结合与 MySQL 数据库课程设计相关文章,强调 SQL 语句调优重要性。为提升数据库性能提供实用方法,适合数据库管理员和开发人员。
|
9月前
|
SQL 大数据 数据挖掘
玩转大数据:从零开始掌握SQL查询基础
玩转大数据:从零开始掌握SQL查询基础
368 35