ODS-ETL开发规范V0.1.docVIP

 文件信息 文件标题 项目名称 项目经理 起草人 起草日期 修订记录 日 期 版 本 修订描述 作 者 文件审核/审批 此文件需如下审核 姓 名 职务/职称 签 名 签名日期 文档分发 此文档将分发至如下个人或机构 姓 名 职务/职称 签 名 签名日期 前言 本标准是针对IBM DB2数据库SQL编写设计而起草的开发规范；同时，也作为中信银行ODS项目ETL组评审ETL任务开发质量的标准之一。 本标准将作为中信银行ODS项目规范开发系列之一，并且需要在项目实施工作中不断改进和完善，保障规范能够真正的提高质量和效率。 引言 总则 整个ODS系统中ETL开发的编码，包括基于封装的程序包中的代码，在对象的命名和使用、程序的注释和排版，都应当注重规范 在编码的过程中，应时刻牢记优化的重要性，对重要程序块或程序包需要注明其逻辑结构。在必要的时候，还应进行代码评审 应用 本规范适用各IBM DB2数据库和中信银行ODS项目ETL开发的程序包 应用于ODS系统基于数据库的ETL模块开发并对应用集市相关开发提供参考与指导 参考文档 《T-SQL Coding Standards》——Brian Walker 术语和定义 描述术语 本文档采用以下的术语描述： 规范：编程时强制必须遵守的原则标准：量化的规范。 说明：对此规则或建议进行必要的说明和解释。 示例：对此规则或建议给出适当的例子。 编码术语 编码(Coding) 关键字(Keyword) 函数(Function) 存储过程(Procedure) 变量(Variable) 游标(Cursor) ETL(Extraction、Translation、Loading) 编码规范 命名规范 命名只能使用26个英文字母、下划线或阿拉伯数字，不能使用汉字。 所有关键字和函数大写；变量、游标、表名、列名可以混合大小写，也可以小写，但不得大写；数据类型小写。 对象命名不能超过8个英文字母，前缀和单词之间用下划线分隔，尽量不采用汉语拼音，使用英文单词或公认单词缩写，单词缩写可通过去掉“元音”形成。 名称具有复数意义时，使用名词的正确的复数形式 当一个SQL 语句中涉及到多个表时，始终使用表名别名来限定字段名。这使其他人阅读起来更清楚，避免了含义模糊的引用。 一般情况下，列名称不应包含表名或者表名的任何形式，列名不允许使用统一的前缀。 所有存储过程的前缀统一使用”proc_” 用户Schema不允许使用系统Schema。 注释规范 开始注释。 示例： /*=====================================================================+ 函数名称：XXXXXXXXXXXXX 参 数: 返 回 值：XX 功能描述：XXXXXXXXXXXXX 目 标 表：XXXXXXXXXXXXX 源 表： 调用函数列表： ETL.F_XXXXXXXX() XXXXXXXXXXXXX 编写人员：XXX 设计日期：2008/8/20 修改历史： 修改日期 修改人员 修改原因 ----------------------------------------------------------------------- 存在问题： ----------------------------------------------------------------------- +=====================================================================*/ 可采用单行/多行注释。（-- 或 /* */ 方式） 示例： login_id VARCHAR2(32) NOT NULL, -- 会员标识 注释单独成行、放在语句前面.注释的内容要清楚、明了，含义准确，无二义性。 对变量的定义和分支语句（条件分支、循环分支等）必须编写注释。对较为复杂的SQL语句加上注释，说明算法、功能. 通过对函数、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。 排版规范 缩进 低级别语句在高级别语句后的，一般缩进4个空格, 建议使用Ultraedit作为SQL书写工具： 示例： DECLARE v_MemberId VARCHAR2(32); SET STARTM = CHAR(CURRENT TIME); BEGIN SELECT admin_membe