fujian_water_biz_doc/templates/303-数据库设计说明书（简版).md

项目名称

数据库设计说明书

文件状态：	文档密级：	公开
【 】草稿
【 】修改稿
【√】正式发布
	当前版本：	V1.0
	作者：
	完成日期：

版本历史

日期	版本号	作者	备注
	V1.0		起草
修改内容
增加内容
删除内容
日期	版本号	作者	备注
修改内容
增加内容
删除内容

目录

• 目录
• 前言
  • 背景
  • 编写目的
  • 术语与缩略语
  • 参考文档
• 外部设计
  • 环境说明
  • 约定
  • 指导
• 数据库设计说明
• 表结构设计
  • 数据表总体概览
  • 数据表设计
    • 英文表名1（中文名）
    • 英文表名2（中文名）
• 视图的设计
  • 视图总体概览
  • 视图详细设计
    • 英文视图名（中文名）
    • 英文视图名（中文名）
• 安全保密设计
• 使用的文字处理和数据库工具
  • 文字处理软件
  • 数据库工具

前言

文档编写原则：

1、所有修改调整都必须如实记录；

2、对系统功能的修改，都必须对修改进行说明；

整个文档编写说明：

1. 文档编写完成后，请删除文档中出现的全部"填写说明"；

2. 提交前，请刷新"目录"、"图表目录"， 更新页眉页脚；

背景

编写目的

术语与缩略语

填写说明：在本文当中出现的专业性、缩略、专有和难懂性的词组或短语

术语、缩写	解释

参考文档

填写说明：编写本文当时参见的其他文档和本文档中的内容参见的其他文档，序号可自然增长

序号	参考文档
1.
2.

外部设计

环境说明

1、说明所采用的数据库系统，设计工具，编程工具, 详细配置。

2、说明数据库服务器的基本硬件配置。

3、简单介绍同此数据库直接有关的支持软件。说明这些软件的名称、版本号的主要功能特性。列出这些支持软件的技术文件的标题、编号及来源。

约定

填写说明：数据库开发的基本规范，如命名规范（表、视图、索引、外键、序列、函数、存储过程）、字段类型等

举例：

1、所有数据项都统一使用XXXXX（如拼音全拼或英文等）的命名方式表示，数据库名称除外。字符集采用XX，排序规则采用XX，编码方式采用XX，请注意字符的转换。

2、所有数据表第一个字段都是系统内部使用主键列，自增字段，不可空，名称为：id，确保不把此字段暴露给最终用户。

3、除特别说明外，所有字符串字段都采用varchar(50)类型，(无论汉字还是英文，都算一个字符）。

4、除特别说明外，所有小数字段都采用decimal(13,3)形式表达。

5、除特别说明外，所有日期格式都采用date格式，无时间值。除特别说明外，所有整型都采用int格式。

6、除特别说明外，所有字段默认都设置为null。

指导

1、向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导。

2、本项根据实际情况填写。

数据库设计说明

填写说明：

1. 数据库的设计规范概述，如分库分表划分的说明。

2. 数据库的账号划分规则，如按租户或岗位功能等。

表结构设计

填写说明：主要是设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成表结构设计中的表，但是它们并不一定是一一对应的。

数据表总体概览

填写说明：数据表总体概览列出。

数据库1（说明数据库类型、实例、表空间、服务名等）

表名	表中文名	描述

数据库2（说明数据库类型、实例、表空间、服务名等）

表名	表中文名	描述

数据表设计

英文表名1（中文名）

中文名	字段名	类型	长度	小数点	是否可空	缺省值	主键	注释

索引

英文表名2（中文名）

中文名	字段名	类型	长度	小数点	是否可空	缺省值	主键	注释

视图的设计

视图总体概览

数据库1（说明数据库类型、实例、表空间、服务名等）

视图名	视图中文名	描述

数据库2（说明数据库类型、实例、表空间、服务名等）

视图名	视图中文名	描述

视图详细设计

英文视图名（中文名）

中文名	字段名	类型	字段所属表名	备注

英文视图名（中文名）

中文名	字段名	类型	字段所属表名	备注

安全保密设计

填写说明：

1、使用者在使用此数据库时，由于不同的访问者的登录号码不同，且增加了密码设置，故相当于对于数据的访问设置了权限，所以数据可以说是安全的。

使用的文字处理和数据库工具

文字处理软件

填写说明：

1、编写设计文档使用的文字处理软件。

数据库工具

填写说明：

1、数据库客户端软件或设计工具。