数据库对象命名规范V3.0.doc

CMMI标准文件数据库对象命名规范（版本号 V3.0） 朗新科技股份有限公司 二一四年三月更改履历版本号修改编号更改时间更改的图表和章节号更改简要描述更改人批准人1.00012012-4-6初稿吴志伟1.10022012-9-6修改并扩展臧冰凌2.00032013-05-15版本OSSP过程改进王建峰黄千峰3.00042014-03-03版本OSSP过程改进王建峰黄千峰注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。数据库对象命名规范目 录1概述11.1编写目的11.2约定11.3使用范围11.4参考文献12数据库对象命名规范12.1概述12.2一般规范22.2.1语言22.2.2大小写22.2.3单词分隔22.2.4保留字22.2.5命名长度22.2.6字段名称22.3功能分类22.4业务分类32.5数据库名及字符集32.6模式42.7表空间52.8数据库其它对象62.8.1数据库对象前缀62.8.2表和字段命名规范72.8.3包及包内对象72.8.4触发器72.8.5约束、索引82.8.6类型82.8.7序列82.8.8视图、物化视图92.8.9表分区92.8.10JOB93附件1：数据库连接104附件2：调用其他系统对象规则11朗新科技股份有限公司 版权所有2014131 概述本文描述了开发中心在数据库对象的命名规范。为了使代码可读性好，可维护性高，使不同的开发人员维护相同的代码，保持代码的一致性，所有的代码和文档应遵循下面的规则和约定。有些项是强制的，而其他项是可选的。希望所有开发成员都能遵循这些标准，特别是新的代码或需要大幅修改的代码。本文并非最终文档，随着技术的发展应随时进行更新。1.1 编写目的规范数据库程序的设计人员、开发人员和系统维护人员，共同遵循这些标准。1.2 约定此文档适用于公司各产品系统原型开发及测试环境。1.3 使用范围开发中心技术架构师、产品构架师、数据架构师、开发DBA、数据库设计人员、开发人员、系统维护人员1.4 参考文献2 数据库对象命名规范2.1 概述在项目需求分析阶段，就需明确项目的数据库对象命名规范。以本规范要求为基础，进一步完善项目特有命名规范。如：根据主业务功能分类(功能域/子域)规范对象名前缀。如本规范与项目特有命名规范冲突，以项目命名规范为准。2.2 一般规范2.2.1 语言命名使用英文单词，不使用复数。英文单词使用同对象本身意义相对或相近的单词。选择最简单或最通用的单词。不能使用毫不相干的单词来命名。当一个单词不能表达对象含义时，用词组组合，如果组合太长时，采用简写或缩写，缩写要基本能表达原单词的意义。当出现对象名重名时，是不同类型对象时，加类型后缀以示区别。禁止使用中文或拼音缩写进行命名2.2.2 大小写名称一律大写，以方便不同数据库移植，以及避免程序调用问题2.2.3 单词分隔命名的各单词之间使用下划线”-”进行分隔。命名的各单词之间不允许有空格存在2.2.4 保留字命名不允许使用SQL保留字，单个命名时不可以，但可与其它字符组合使用。2.2.5 命名长度表名、字段名、视图名长度应限制在29个字符内(含前缀)。2.2.6 字段名称同一个字段名在一个数据库中只能代表一个意思。不同的表用于相同内容的字段应该采用同样的名称及字段类型。2.3 功能分类将产品按照不同功能进行分类，通常来说不同业务功能之间尽可能不存在耦合情况，每个功能区可以完全独立部署，以国网稽查项目举例：遵循国网三大功能域化分标准。功能域分类英文缩写监控域KM分析域KA稽查域KC2.4 业务分类将产品在功能分类的基础上进一步细分业务类，以国网稽查项目举例：遵循国网营销稽查监管精细化设计25大业务类化分标准。缩写业务分类英文be新装、增容及变更用电 Business Expandingsc供用电合同管理 Supply contract managementmr抄表管理 METER READINGac核算管理 Accounting check managementca电费收缴及营销帐务管理 CHARGE Account managementchk用电检查管理 CHECKcc95598业务处理 CALLCENTERam资产管理 asset managementmp计量点管理 METER POINTms计量体系管理 Measurement systemepc电能信息采集 Electric Power COLLECTmm市场管理 Marketing managementllm线损管理 LINELOSS managementeem能效管理 Energy efficiency managementop有序用电管理 ORDERLY POWERcrm客户关系管理 Customer Relationship Managementclg客户联络 Guided Missile Light Cruiserwq稽查及工作质量 WORK QUALITYcus客户档案管理 customer archives managementsp系统支撑功能 System Support pm供电监控Power monitoringdq数据质量Data Qualitysr服务资源Service resourcesrm报表管理Report Managementpa稽查绩效Performance auditod运营动态Dynamic operations2.5 数据库名及字符集数据库名通常以产品中文名称缩写来命名，并且数据库名必须为小写，数据库名不超过7位。以国网稽查项目举例：在公司开发环境中的数据库命令通常为：gwjckf（开发库）、gwjcalp（alpha库）、gwjcbt（beta库）、gwjcrs（release库）在用户现场的正式库命令通常为：zjjcdb（浙江稽查库）、zjjcdb1（浙江稽查库实例1）、zjjcdb2（浙江稽查库实例2）没有特殊要求的情况下，数据库的语言、字符集、国际字符集统一设置成如下：语言：AMERICAN_AMERICA数据库字符集(NLS_CHARACTERSET)：UTF8国家区域字符集(NLS_NCHAR_CHARACTERSET)：UTF82.6 模式模式命令通常遵循产品名作为前缀的规范，根据不同的功能可以设计多个模式。模式命令通常遵循产品名_功能模块名的规范，如前面我们定义了KM（监控域）、KA（分析域）、KC（稽查域）三个功能模块，那么对应的我们定义三个模式，名称分别为gwjc_km、gwjc_ka、gwjc_kc。如果需要与外围第三方程序进行数据交互的，那么创建一个接口模式，模式命令通常遵循产品名_API的规范，如在范例中我们创建一个gwjc_api模式。如果需要与其它数据库进行数据交互的，那么创建2个相应的模式，一个模式用于内数据库访问对方数据库，另一个模式用于对方数据库来访问本数据库的相关对像。模式命令通常遵循产品名_dblnki/dblnko的规范，如在范例中我们创建两个模式，分另为gwjc_dblnki和gwjc_dblnko模式。其中gwjc_dblnki用于本数据库访问外方数据库，gwjc_dblnki用于对方数据库访问本数据库。以国网稽查项目举例：模式名（oracle里通常理解为用户）模式描述数据库默认表空间临时表空间权限备注gwjc_km管理营销稽查监管监控域数据及程序包营销稽查监管系统DATA_KMTEMP视需求而定gwjc_ka管理营销稽查分析域数据及程序包体营销稽查监管系统DATA_KATEMP视需求而定gwjc_kc管理营销稽查稽查域数据及程序包体营销稽查监管系统DATA_KCTEMP视需求而定gwjc_dblnki用于SG186营销工作流引擎取DSS数据营销稽查监管系统userTEMP视需求而定gwjc_dblnko用于考核系统获取检查数据营销稽查监管系统userTEMP视需求而定gwjc_api外围系统数据交互接口营销稽查监管系统DATA_APITEMP视需求而定2.7 表空间表空间的创建通常根据所保存的数据类型来区，1. 每个功能模块创建一个数据表空间和索引表空间2. 为接口模式单独创建数据表空间和索引表空间表空间命令通常遵循DATA_功能模块名、IDX_功能模块名的规范，如前面我们定义了KM（监控域）、KA（分析域）、KC（稽查域）三个功能模块，那么对应的我们创建6个表空间，名称分别为data_km、data_ka、data_kc、idx_km、idx_ka、idx_kc。如果需要与外围第三方程序进行数据交互的，那么创建2个与接口模式相对应的表空间，分别用于保存表数据和索引，这部份表空间名统一定义为data_api和idx_api。针对归档数据单独创建表空间，data_arc,idx_arc初始大小需根据业务需求进行评估。以国网稽查项目举例：业务分类表数量表空间名索引表空间名初始大小说明监控域308DATA_KMIDX_KM1G稽查监管系统中关于监控域的表和索引表空间分析域180DATA_KAIDX_KA1G稽查监管系统中关于分析域的表和索引表空间稽查域68DATA_KCIDX_KC1G稽查监管系统中关于稽查域的表和索引表空间外围接口DATA_APIIDX_API10M保存数据库中大外围接口应用数据2.8 数据库其它对象 总则：1、数据库对象如有行标，将以行标(如国网标准)为准。2、按数据库对象类型与业务分类相结合的命名规则。3、数据库内不编写单独的存贮过程和函数，过程和函数都写在包中。4、命名中的功能描述可以缩写。5、对象名称全部使用大写。6、对象通用命名采用：对象类型前缀_分类前缀_友好对象名来命名。2.8.1 数据库对象前缀数据库内不编写单独的存贮过程和函数，过程和函数都写在包中。命名中的功能描述可以缩写。对象名称模型设计时全部使用大写，开发时使用小写。常用数据库对像命名前缀规范表：数据库对象对象子类命名前缀备注包PKG_优先使用行标（如SG标准）包内过程P_优先使用行标（如SG标准）包内函数F_优先使用行标（如SG标准）触发器TRG_优先使用行标（如SG标准）自定义类型TYP_优先使用行标（如SG标准）表见2.8.2章节优先使用行标（如SG标准）视图普通V_优先使用行标（如SG标准）物化视图MV_优先使用行标（如SG标准）约束CON_优先使用行标（如SG标准）主键PK_优先使用行标（如SG标准）外键FK_优先使用行标（如SG标准）唯一UK_优先使用行标（如SG标准）索引全局IDX_优先使用行标（如SG标准）分区LOC_优先使用行标（如SG标准）位图BMP_优先使用行标（如SG标准）函数FUN_优先使用行标（如SG标准）序列SEQ_优先使用行标（如SG标准）目录DIR_优先使用行标（如SG标准）同义词SY_优先使用行标（如SG标准）2.8.2 表和字段命名规范2.8.2.1 表(实体)命名必须为表名加入业务分类前缀，业务分类前缀标准在项目命名规范中定义。命名：业务分类前缀_表友好名范例：PM_ROLE_FUNCTION（权限管理_角色功能表）PM：权限管理ROLE_FUNCTION：角色功能表（表友好名）2.8.2.2 固定表分类前缀SYS_：系统信息类，如SYS_LOG日志CFG_：配置类，CFG_COMPANY公司配置ARC_：归档表，这个表与是与在线表相对的，当在线表中相对较大，并且是线性增长的，如果其中的大部分记录在日常在线交易中使用机率较小，则需要对这部份数据进行归档，那么创建归档表，将这部分记录定期迁移到归档表中。HIS_：历史信息类，当在线表或归档表的记录因业务的原因不再需要保存在在线库中时，那么在历史库中创建相应的历史表。如：HIS_01_SI_HEAD一月份的补料历史信息2.8.2.3 字段命名字段意义的英文全名或缩写。2.8.3 包及包内对象包名：PKG_业务分类前缀_包友好名包内过程名：P_过程友好名包内函数名：F_函数友好名包内常量名：C_常量友好名包内变量名：V_变量友好名包内输入参数名： IN_参数友好名包内输出参数名： OUT_参数友好名包内游标名：CUR_游标友好名包内类型名：TYP_类型友好名2.8.4 触发器触发器名：对象类型(trg)_触发对象名缩写_触发点缩写触发对象名缩写：表名或视图名缩写，应保留部分前缀触发点缩写：_BF 之前before(一般适用于关联表处理)_AF 之后after(一般适用于关联表处理)_IF 替代instead of(一般适用于视图处理)2.8.5 约束、索引约束：主键、唯一键名同其对应的索引名，其它约束参照常用数据库对像命名前缀规范表。索引：对象类型前缀_表名(可缩写)_字段名(可缩写)，如：idx_cu_cons_cbqm2.8.6 类型对象类型前缀_分类前缀_友好对象名，参见2.8,1章的常用数据库对像命名前缀规范表。2.8.7 序列序列：序列命名规范采用：对象类型_业务分类_友好名称。如，用户号序列：seq_c_cunsumerid。序列使用详细规范，以营销系统为例：1、按照国网10个数据域分别规化各个数据域的序列号，每个域须保证至少一个序列生成器，最多不得超过20个。2、序列的CACHE统一使用500，初始值使用1，步长1，最大值为16个“9”,nocycle，noorder。3、序列使用统一的公共包pkg_sp_seq内的各函数生成(比如pkg_sp_seq.f_a_htid)，函数由技术组创建，默认每一个数据域一个函数，函数与序列一一对应，默认函数的命名规则为：f_数据域英文缩写(单字母)_defid，表名首字母与函数名第三个字符对应。比如：产品数据域（e开头）中的大多数表的ID都应该由pkg_sp_seq.f_e_defid函数生成。4、每个数据域可以另建序列但共计不得超过20个，每个数据域中满足以下条件可以另建序列：a、该ID号更新或插入批量操作比较频繁且并发操作比较多(比如电费和帐务中的批量电费计算和批量下帐的各表的ID号可以考虑分别创建序列);b、有业务逻辑或多数据域共同维护的字段，比如用户号、流程传单编号等。5、需要另建序列请填下表，并提交技术组统一维护并将函数名反馈给申请部门。序号数据域（10类中文）表名表中文名字段名字段中文名是否有序备注1量测域R_RPT抄表报表MR_RPT_ID抄表报表标识否2.8.8 视图、物化视图命名规则遵循以下规范：对象类型前缀_业务分类前缀_友好对象名，参见两表关联视图友好名：表A名_表B名，关联多表的时可以用视图功能含义来定义。2.8.9 表分区分区命名遵循P+分区值的原则。子分区遵循P+主分区值+_+P+子分区值的原则。如