数据库开发规范.doc

XXX科技技术规范数据库开发规范目录1、 目的 22、 读者 23、 名词解释 24、 存储过程开发规范 名称规范 注释规范 命名规范 参数的命名 变量命名 模板规范 存储过程功能模块组成说明 过程名定义 过程注释 过程体 存储过存功能模板(附件) 日志 功能 调用方法 日志查询 日志结果 日志过程(附件) 日志表(附件) 书写规范和优化方法 操作符优化 SQL书写的影响 WHERE后面的条件顺序影响 查询表顺序的影响 SQL语句索引的利用 12目的为了提高项目开发效率及所开发软件的可维护性,提高软件的质量,避免文件、目录、公用参数名字冲突,统一项目组内部开发风格,增加程序可读性和可理解性。读者本文适用以下读者:ETL设计、开发人员。名词解释存储过程开发规范名称规范注意事项:一、存储过程名称全部使用英文,参数注释也必须使用英文。以SP开头格式如下:SP_[TABLENAME]<TABLENAME为目标表>。二、函数名称全部使用英文,参数注释也必须使用英文。以FN开头格式如下:FN_[……],如:FN_LOG_EXEC。报表类存储过程命名规则:SP_RPT_[部门]_[报表功能]_[月表M,日表D]编号中文说明存储过程名-------------------------------------------2DY0001网银开销户统计表SP_RPT_DY_WYKXHTJB_M注释规范存储过程注释信息应包含如下信息:------------------------------------------------------版权信息:版权所有(c)2014,--文件名称:--版本号:--创建者:system--创建日期:2014-01-01--内容摘要:--功能描述:生成核心客户信息表O_HX_CUST_INFO--运行频率:日跑--传入参数:I_STATEDATE--业务日期--O_FLAGINTEGER--返回过程运行状态0-正常结束1异常--更改历史:--更改日期:--更改人:lys--更改说明:----------------------------------------------------命名规范注意事项:存储过程命名全部使用英文,参数注释也必须使用英文。参数的命名所有的输入、输出均采用参数赋值,参数名称需为英文数字下划线不能有汉字,参数名称最好是有意义的英文组成,方便阅读理解。参数名如下:输入:I_参数名输出:O_参数名变量命名所有的变量名称:变量类型首写字母_变量名称,变量名称最好是有意义的英文组成,方便阅读理解。数字变量变量名称:需在前面加个‘N_’如:N_SQLCODE变量定义:V_SQLCODENUMBER:=0;变量付值:V_SQLCODE:=’1’;注:左右边类型必须一致。字符串变量变量名称:需在前面加个‘V_’如:V_STATMONTH变量定义:V_STATMONTHVARCHAR2(8):=’20110819’;变量付值:V_STATMONTH:=’20110819’;注:左右边类型必须一致。模板规范存储过程功能模块组成说明对基础数据进行汇总,生成报表。过程名定义CREATEORREPLACEPROCEDURESP_LOG_EXEC(NATIONALCHARACTERVARYING(100),CHARACTERVARYING(10),TIMESTAMP,INTEGER,INTEGER)RETURNSINTEGERLANGUAGENZPLSQLASBEGIN_PROCDECLAREI_PRC_NAMEALIASfor$1;O_FLAGinteger;注:参数赋值时候需要与参数列表中顺序一一对应。参数O_FLAG,为过程出参,这里是返回过程运行状态,判断该过程是否正确运行完成,以便判断后续作业是否继续,这里规定每个过程都必需有这个出参,并且在过程运行过程中对该参数进行付值,如过程运行出现异常退出时,需返回值-1,如过程正常结束,则付值0。过程注释过程注释说明该过程的功能、创建人、创建时间及参数用途等------------------------------------------------------版权信息:版权所有(c)2014,--文件名称:--版本号:--创建者:system--创建日期:2014-01-01--内容摘要:--功能描述:生