库表设计与操作规范V10模板

《库表设计与操作规范V10模板》由会员分享，可在线阅读，更多相关《库表设计与操作规范V10模板（12页珍藏版）》请在金锄头文库上搜索。

1、 库表设计与操作规范 1/12 库表设计与操作规范库表设计与操作规范 文档编号文档编号：库表设计与操作规范 文档信息文档信息：公司级别规范文件 文档名称文档名称：编程规范 文档类别文档类别：工程过程 密密 级级：内部 版本信息版本信息：1.0 建立日期建立日期： 创创 建建 人人： 审审 核核 者者： 批批 准准 人人： 批准日期批准日期： 保保 管管 人人： 存放位置存放位置： 库表设计与操作规范 2/12 文档修订记录 版本编号或者 更改记录编号 *变化 状态 简要说明（变更内容和变更 范围） 日期变更人批准日期批准人 10 A 新增 2014-1-15 彭毅 *变化状态：A增加，M修改，

2、D删除 文档审批信息 序号审批人角色审批日期签字备注 库表设计与操作规范 3/12 目录 1简介 .4 1.1目的 .4 1.2适用范围 .4 1.3背景描述 .4 1.4文档结构 .4 2命名规范 .5 2.1数据结构规范 .5 2.2数据库操作规范 .11 库表设计与操作规范 4/12 1 1 1 简介简介简介 1.11.11.1 目的目的目的 本文制定的目的是为开发组所有程序员按统一风格、形式提供一个标准，从而改进代码的可 维护性，提高代码质量。 1.21.21.2 适用范围适用范围适用范围 本文档的适用范围为：数据库设计人员、数据维护人员。 1.31.31.3 背景描述背景描述背景描述

3、 库表规范对于设计人员、整个组织非常的重要： 软件成本的 80%来自于维护 几乎没有一个软件从始至终是有一个人维护的 软件规范可以改进代码的可读性，使得程序员能够很快的、彻底的理解库表设计 1.41.41.4 文档结构文档结构文档结构 该文挡主要分为两部分：库表设计、命名规范和库表操作规范。 库表设计与操作规范 5/12 2 2 2 命名规范命名规范命名规范 2.12.12.1 数据结构规范数据结构规范数据结构规范 2.1.12.1.12.1.1 术语术语术语术语 数据库对象数据库对象：在数据库软件开发中，数据库服务器端涉及的对象包括物理结构和 逻辑结构的对象。 物理结构对象物理结构对象：是指

4、设备管理元素，包括数据文件和事务日志文件的名称、大小、 目录规划、所在的服务器计算机名称、镜像等，应该有具体的配置规划。一般对数 据库服务器物理设备的管理规程，在整个项目/产品的概要设计阶段予以规划。 逻辑结构对象逻辑结构对象：是指数据库对象的管理元素，包括数据库名称、表空间、表、字 段/域、视图、索引、触发器、存储过程、函数、数据类型、数据库安全性相关的设 计、数据库配置有关的设计以及数据库中其他特性处理相关的设计等。 2.1.22.1.22.1.2 命名总体原则命名总体原则命名总体原则命名总体原则 整个命名的全长不得超过 30 个字母 全部使用字母和下划线_，不能使用中文和其他字符，有特别

5、情况允许使用末尾 数字编号。例如：Finace1， Finace2. 命名名称来自于业务，全部采用英文单词 英文单词过长可以采用通用的缩写，尽量表达出业务的含义 如需要两个以上的英文单词做标识名称，单词之间要用下划线_连接 名称全是由名词组成的，名词由大范围到小范围排序取名 库表设计与操作规范 6/12 完成某功能的名称，如函数和过程，以动宾形式取名 2.1.32.1.32.1.3 命名规范（逻辑对象）命名规范（逻辑对象）命名规范（逻辑对象）命名规范（逻辑对象） 1 数据库结构命名数据库结构命名 a) 数据库命名数据库命名 数据库的命名要求使用与数据库意义相关联的英文字母，即。 例如：chin

6、a care 数据库的命名为 ccnet； b) 数据库日志设计命名数据库日志设计命名 数据库日志的命名以_.log 格式命名。其中，为有 意义的数据库日志名称。 例如： ccnet_redolog.log c) 表空间、数据文件命名表空间、数据文件命名(主要针对主要针对 Oracle) 表空间名不超过 32 位,为方便维护应尽量与当前的应用同名，如果小涉及到多用 户访问的同一用户数据可以用综合名，或 COMMON、或有一定共同约束的命名。 d)用户命名用户命名 用户的命名应与表空间对应，每个用户下的数据必须放到与用户相同的表空间之 下。同样用户名不超过 32 位。 2 数据库对象命名数据库对

7、象命名 a) 表表 表的命名格式为： 系统标识_。 库表设计与操作规范 7/12 其中， 为必埴项，依据实际情况而增加； 要求与表的意义相关联的英文 字母，例如：CRM_CUSTOMER。 数据表大致分为： 业务数据表，根据业务的实际情况来命名，如：CRM_XXX、CMS_XXX 系统管理表: SYS_XXX 工作流数据表： WF_XXX 报表数据表：RP_XXX； 表单自定义数据表：FD_XXX 注：表名不超过 32 字符，层次深度不超过 5 层，如:：WF_AA_BB_CC_DD，这个 为最大的允许深度，每张表必须要有注释； 没有系统标识的数据表为默认的用户（对应的项目）的业务数据表。 b

8、) 字段字段/域域 根据业务要求进行命名，不需设定固定的前缀。 每张表必须要有: ID NUMBER(10) not null, /主键 CDP VARCHAR2(50) not null, /创建人 CDT DATE not null, /创建时间 EDP VARCHAR2(50), /修改人 EDT DATE, /修改时间 每个字段必须要有注释 c) 索引索引 库表设计与操作规范 8/12 针对数据库表中一个或多个字段建立的索引的命名格式应以”IDX_”开头，索引列 名间用_隔开，即为 IDX _ColumnName1_ColumnName2_；其中，ColumnName1 是数据库表中（

9、第一个）索引字段的名称或名称简写；ColumnName2 是数据库表 中（第二个）索引字段的名称或名称简写；索引名的总长必需符合数据库的规定。 例：idx_cert_number (表示在字段 cert_number 上创建索引) 为了避免重名索引出现，可选命名方式为 idx_ 作为索引的命 名，但是要求在数据字典中进行详细说明 d) 视图视图 视图的命名必须以”v_”(View 缩写)开头，格式为： v_系统标识 _。 其中，视图类型参见”表的分类说明”；系统标识_是可选项，依据情况而增加； 应与视图意义相关联的英文字母。 例：v_user_detail_info e) 存储过程存储过程 存

10、储过程的命名必须符合 sp_系统标识_格式。 其中，sp 表示是存储过程；系统标识为可选项，依据情况而增加；是与存储过程意义相关联的英文字母，例如： 例：sp_check_user_auth（以动宾方式取名） f) 触发器触发器 触发器的的命名必须符合 tr_ 格式。 库表设计与操作规范 9/12 其中，tr 表示是触发器；是与触发器意义相关联的英文字 母。 例：tr_user_info_iu （表示对 user_info 表进行插入、更新的触发器） g) 函数函数 函数的命名必须符合 fn_系统标识_格式。 其中，fn 表示是函数，系统标识为可选项，依情况而定；是与函数 意义相关联的英文字母

11、。 例：fn_create_id（以动宾方式取名） h) 自定义数据类型自定义数据类型 自定义数据类型的命名格式为：ud_ i) Default（缺省）（缺省） Default（缺省）的命名格式一般为：df_；对于非绑定的默认可 取系统默认的名字。 j) Check、Constraint（约束）（约束） 约束的命名格式一般为：ck_ ；一些约束可直接放在生成 表的语句中。 例：ck_flag，约束字段 flag 只能取字符0到9： constraint ck_flag CHECK (flag between 0 and 9 ) k) Rule（规则）（规则） 库表设计与操作规范 10/12 规

12、则的命名格式一般为：rl_；对于非绑定规则(约束) 可取系统默认 的名字，参见第 10 点设计实例绑定具体字段。 l) 主键主键 主键的命名格式为 pk_。 例：pk_user_info_userid （表 user_info 以字段 userid 创建主键） m) 外键外键 外键的命名格式为 fk_。 可选命名方式为 fk_ 作为索引的命名，但是要求在数据字典 中进行详细说明 例：fk_user_info_department_deptid （在表 user_info 的字段 department_id 上创建外键，参照主表 department） n) 同义词（同义词（ORACLE） 同义

13、词的命名格式为：sy_ 例：sy_user_info （为所有权属于 ben 的表 user_info 的公共同义词） 脚本注释脚本注释 1 存储过程或触发器存储过程或触发器 a) 每一个存储过程或触发器都要在最前面写注释。 2 自定义函数自定义函数 a)每一个自定义函数都要在其前面写注释。 库表设计与操作规范 11/12 2.22.22.2 数据库操作数据库操作数据库操作规范规范规范 1 建立、删除、修改库表操作建立、删除、修改库表操作 确认需做数据操作 操作前的数据备份 数据操作 数据操作说明 在开发环境中，对于自己的库表可进行修改、删除操作；需要做相应的操作前备 份和操作后的登记。 在进

14、行生产环境的数据操作时，必须要先做好数据备份。并需保留相应的说明。 2 添加、删除、修改表数据添加、删除、修改表数据 在开发环境中，开发人员所开发模块独自使用的库表，可自由操作表中数据； 对其他模块关联的库表，应取得其他模块的开发人员同意后再执行操作； 系统的信息表、字典表的修改应向项目经理提出操作需求，由项目经理执行操作。 库表设计与操作规范 12/12 3 3 3 检查清单检查清单检查清单 命名命名规规范范 重要性审查项审查内容合格 存储空间名称所有名称是否用英语书写，是否有超过 32 字节 用户名称所有名称是否用英语书写，是否有超过 32 字节 表、视图等对象名 称 所有名称是否用英语书写，是否有超过 32 字节；多层含义之 间是否“_”分开，是否层次超过 5 层 字段名称所有名称是否用英语书写，是否有超过 32 字节；多层含义之 间是否“_”分开，是否层次超过 5 层 注释所有对象（表、视图、方法、字段等）是否有写中文注释；如 果存在原语，是否有说明相关原语的含义 操作操作 重要性审查项审查内容结论 操作说明操作前是否有说明本次主要处理事项，以及为何需要处理 操作前备份是否有做操作前的数据备份