数据库设计说明书模板

XXX项目

数据库设计说明书

（V1.0）

修改记录

版本号	变更控制 报告编号	更改条款及内容		更改人	审批人	更改日期
V1.0		初稿

目录

1 引言

1.1 编写目的

1.2 术语

1.3 预期读者与阅读建议

1.4 参考资料

2 设计数据表结构

2.1 系统用户表：sys_user

2.2 角色表：sys_role

2.3 用户角色表：sys_user_role

1 引言

1.1 编写目的

说明编写这份数据库设计说明书的目的，指出预期的读者。

1.2 术语

列出本文件中用到的专 门术语、术语定义、外文首字母组词的原词组。也可用附件说明。或放到本文件的最后。如没有可直接删除​​​​​​​

1.3 预期读者与阅读建议

描述本文档的主要读者，以及这些读者在阅读时的阅读重点与建议。可用列表的方式列出。如表：

预期读者	阅读重点

1.4 参考资料

列出用得着的参考资料，如：

本项目的经核准的计划任务书或合同、上级机关的批文；

属于本项目的其他已发表的文件；

本文件中各处引用到的文件资料，包括所需用到的软件开发标准。

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

如没有，可直接删除。

2 数据库设计

2.1 ER图

2.2 表说明

表	表名	描述
系统用户表	sys_user
角色表	sys_role
用户角色表	sys_user_role

2 设计数据表结构

数据字典的形成

如：

​​​​​​​2.1 系统用户表：sys_user

名称	代码	注释	数据类型	主键	约束	备注
主键ID	id		varchar(64)	是	唯一
所属公司	company_id		varchar(64)		外键	关联sys_office 主键
所属部门	office_id		varchar(64)		外键	关联sys_office 主键
登录名	login_name		varchar(100)		唯一
密码	password		varchar(100)
工号	no		varchar(100)
姓名	name		varchar(100)
邮箱	email		varchar(200)
电话	phone		varchar(20)
手机	mobile		varchar(20)		唯一
用户类型	user_type		char(1)
管理员类型	mgr_type		char(1)
corp_code	corp_code		varchar(64)
corp_name	corp_name		varchar(100)
集团帐号个数	account_number		int(11)
用户头像	photo		varchar(1000)
最后登陆IP	login_ip		varchar(100)
最后登陆时间	login_date		datetime
是否可登录	login_flag	0:禁止，1:允许	char(1)
创建者	create_by		varchar(64)
创建时间	create_date		datetime
更新者	update_by		varchar(64)
更新时间	update_date		datetime
备注信息	remarks		varchar(1000)
删除标记	del_flag	0:正常，1:删除	char(1)

​​​​​​​2.2 角色表：sys_role

名称	代码	注释	数据类型	主键	约束	备注
主键ID	id		varchar(64)	是	唯一
归属机构	office_id		varchar(64)		外键	关联sys_office主键
角色名称	name		varchar(100)		唯一
英文名称	enname	唯一	varchar(255)		唯一
角色类型	role_type		varchar(255)
数据范围	data_scope	1:所有数据 2:所在公司及以下数据 3:所在公司数据 8:仅本人数据	char(1)
是否系统数据	is_sys	0:否，1:是	varchar(64)
是否可用	useable	0:否，1:是	varchar(64)
corp_code	corp_code		varchar(64)
corp_name	corp_name		varchar(100)
创建者	create_by		varchar(64)
创建时间	create_date		datetime
更新者	update_by		varchar(64)
更新时间	update_date		datetime
备注信息	remarks		varchar(1000)
删除标记	del_flag	0:正常，1:删除	char(1)

​​​​​​​2.3 用户角色表：sys_user_role

名称	代码	注释	数据类型	主键	约束	备注
用户ID	user_id		varchar(64)	是		复合主键
角色ID	角色ID		varchar(64)	是		复合主键