库表设计与操作规范V10模板.docx
- 文档编号:23102065
- 上传时间:2023-04-30
- 格式:DOCX
- 页数:10
- 大小:30.57KB
库表设计与操作规范V10模板.docx
《库表设计与操作规范V10模板.docx》由会员分享,可在线阅读,更多相关《库表设计与操作规范V10模板.docx(10页珍藏版)》请在冰豆网上搜索。
库表设计与操作规范V10模板
库表设计与操作规范
文档编号:
库表设计与操作规范
文档信息:
公司级别规范文件
文档名称:
编程规范
文档类别:
工程过程
密级:
内部
版本信息:
1.0
建立日期:
创建人:
审核者:
批准人:
批准日期:
保管人:
存放位置:
文档修订记录
版本编号或者更改记录编号
*变化
状态
简要说明(变更内容和变更范围)
日期
变更人
批准日期
批准人
1.0
A
新增
2014-1-15
彭毅
*变化状态:
A——增加,M——修改,D——删除
文档审批信息
序号
审批人
角色
审批日期
签字
备注
1简介
1.1目的
本文制定的目的是为开发组所有程序员按统一风格、形式提供一个标准,从而改进代码的可维护性,提高代码质量。
1.2适用范围
本文档的适用范围为:
数据库设计人员、数据维护人员。
1.3背景描述
库表规范对于设计人员、整个组织非常的重要:
Ø软件成本的80%来自于维护
Ø几乎没有一个软件从始至终是有一个人维护的
Ø软件规范可以改进代码的可读性,使得程序员能够很快的、彻底的理解库表设计
1.4文档结构
该文挡主要分为两部分:
库表设计、命名规范和库表操作规范。
2命名规范
2.1数据结构规范
2.1.1术语
数据库对象:
在数据库软件开发中,数据库服务器端涉及的对象包括物理结构和逻辑结构的对象。
物理结构对象:
是指设备管理元素,包括数据文件和事务日志文件的名称、大小、目录规划、所在的服务器计算机名称、镜像等,应该有具体的配置规划。
一般对数据库服务器物理设备的管理规程,在整个项目/产品的概要设计阶段予以规划。
逻辑结构对象:
是指数据库对象的管理元素,包括数据库名称、表空间、表、字段/域、视图、索引、触发器、存储过程、函数、数据类型、数据库安全性相关的设计、数据库配置有关的设计以及数据库中其他特性处理相关的设计等。
2.1.2命名总体原则
●整个命名的全长不得超过30个字母
●全部使用字母和下划线‘_’,不能使用中文和其他字符,有特别情况允许使用末尾数字编号。
例如:
Finace1,Finace2...
●命名名称来自于业务,全部采用英文单词
●英文单词过长可以采用通用的缩写,尽量表达出业务的含义
●如需要两个以上的英文单词做标识名称,单词之间要用下划线‘_’连接
●名称全是由名词组成的,名词由大范围到小范围排序取名
●完成某功能的名称,如函数和过程,以动宾形式取名
2.1.3命名规范(逻辑对象)
1数据库结构命名
a)数据库命名
数据库的命名要求使用与数据库意义相关联的英文字母,即<业务系统名称>。
例如:
chinacare数据库的命名为ccnet;
b)数据库日志设计命名
数据库日志的命名以<数据库名>_<日志名>.log格式命名。
其中,<日志名>为有意义的数据库日志名称。
例如:
ccnet_redolog.log
c)表空间、数据文件命名(主要针对Oracle)
表空间名不超过32位,为方便维护应尽量与当前的应用同名,如果小涉及到多用户访问的同一用户数据可以用综合名,或COMMON、或有一定共同约束的命名。
d)用户命名
用户的命名应与表空间对应,每个用户下的数据必须放到与用户相同的表空间之下。
同样用户名不超过32位。
2数据库对象命名
a)表
表的命名格式为:
[系统标识]__<表标识>。
其中,[]为必埴项,依据实际情况而增加;<表标识>要求与表的意义相关联的英文字母,例如:
CRM_CUSTOMER。
数据表大致分为:
✧业务数据表,根据业务的实际情况来命名,如:
CRM_XXX、CMS_XXX
✧系统管理表:
SYS_XXX
✧工作流数据表:
WF_XXX
✧报表数据表:
RP_XXX;
✧表单自定义数据表:
FD_XXX
注:
表名不超过32字符,层次深度不超过5层,如:
:
WF_AA_BB_CC_DD,这个为最大的允许深度,每张表必须要有注释;
没有系统标识的数据表为默认的用户(对应的项目)的业务数据表。
b)字段/域
根据业务要求进行命名,不需设定固定的前缀。
每张表必须要有:
✧IDNUMBER(10)notnull,//主键
✧CDPVARCHAR2(50)notnull,//创建人
✧CDTDATEnotnull,//创建时间
✧EDPVARCHAR2(50),//修改人
✧EDTDATE,//修改时间
每个字段必须要有注释
c)索引
针对数据库表中一个或多个字段建立的索引的命名格式应以”IDX_”开头,索引列名间用_隔开,即为IDX_ColumnName1_ColumnName2_;其中,ColumnName1是数据库表中(第一个)索引字段的名称或名称简写;ColumnName2是数据库表中(第二个)索引字段的名称或名称简写;索引名的总长必需符合数据库的规定。
例:
idx_cert_number(表示在字段cert_number上创建索引)
为了避免重名索引出现,可选命名方式为idx_<表名>_<递增号>作为索引的命名,但是要求在数据字典中进行详细说明
d)视图
视图的命名必须以”v_”(View缩写)开头,格式为:
v_<视图类型>_[系统标识]_<视图标识>。
其中,视图类型参见”表的分类说明”;[系统标识_]是可选项,依据情况而增加;<视图标识>应与视图意义相关联的英文字母。
例:
v_user_detail_info
e)存储过程
存储过程的命名必须符合sp_[系统标识]_<存储过程标识>格式。
其中,sp表示是存储过程;[系统标识]为可选项,依据情况而增加;<存储过程标识>是与存储过程意义相关联的英文字母,例如:
例:
sp_check_user_auth(以动宾方式取名)
f)触发器
触发器的的命名必须符合tr_<表名>_格式。
其中,tr表示是触发器;是与触发器意义相关联的英文字母。
例:
tr_user_info_iu(表示对user_info表进行插入、更新的触发器)
g)函数
函数的命名必须符合fn_[系统标识]_<函数标识>格式。
其中,fn表示是函数,[系统标识]为可选项,依情况而定;<函数标识>是与函数意义相关联的英文字母。
例:
fn_create_id(以动宾方式取名)
h)自定义数据类型
自定义数据类型的命名格式为:
ud_<自定义数据类型标识>_<数据类型>
i)Default(缺省)
Default(缺省)的命名格式一般为:
df_
j)Check、Constraint(约束)
约束的命名格式一般为:
ck_<表名>_
例:
ck_flag,约束字段flag只能取字符‘0’到‘9’:
constraintck_flagCHECK(flagbetween'0’and'9’)
k)Rule(规则)
规则的命名格式一般为:
rl_
l)主键
主键的命名格式为pk_<表名>_<主键标识>。
例:
pk_user_info_userid(表user_info以字段userid创建主键)
m)外键
外键的命名格式为fk_<表名>_<主表名>_<外键标识>。
可选命名方式为fk_<表名>_<递增号>作为索引的命名,但是要求在数据字典中进行详细说明
例:
fk_user_info_department_deptid(在表user_info的字段department_id上创建外键,参照主表department)
n)同义词(ORACLE)
同义词的命名格式为:
sy_<同义词标识>
例:
sy_user_info(为所有权属于ben的表user_info的公共同义词)
脚本注释
1存储过程或触发器
a)每一个存储过程或触发器都要在最前面写注释。
2自定义函数
a)每一个自定义函数都要在其前面写注释。
2.2数据库操作规范
1建立、删除、修改库表操作
在开发环境中,对于自己的库表可进行修改、删除操作;需要做相应的操作前备份和操作后的登记。
在进行生产环境的数据操作时,必须要先做好数据备份。
并需保留相应的说明。
2添加、删除、修改表数据
在开发环境中,开发人员所开发模块独自使用的库表,可自由操作表中数据;
对其他模块关联的库表,应取得其他模块的开发人员同意后再执行操作;
系统的信息表、字典表的修改应向项目经理提出操作需求,由项目经理执行操作。
3检查清单
命名规范
重要性
审查项
审查内容
合格
存储空间名称
所有名称是否用英语书写,是否有超过32字节
用户名称
所有名称是否用英语书写,是否有超过32字节
表、视图等对象名称
所有名称是否用英语书写,是否有超过32字节;多层含义之间是否“_”分开,是否层次超过5层
字段名称
所有名称是否用英语书写,是否有超过32字节;多层含义之间是否“_”分开,是否层次超过5层
注释
所有对象(表、视图、方法、字段等)是否有写中文注释;如果存在原语,是否有说明相关原语的含义
操作
重要性
审查项
审查内容
结论
操作说明
操作前是否有说明本次主要处理事项,以及为何需要处理
操作前备份
是否有做操作前的数据备份
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 设计 操作 规范 V10 模板