软件数据库设计方案报告文档模板.docx

软件数据库设计汇报文档模板 1. 引言451.1 编写目标451.2 项目起源451.3 文档约定451.4 预期读者和阅读提议451.5 参考资料452. 数据库命名规则463. 数据库设计说明463.1 数据库逻辑设计463.2 数据库物理设计463.3 数据库分布473.4 基表设计473.5 视图设计483.6 索引设计493.7 完整性约束503.8 授权设计503.9 触发器设计513.10 存放过程设计513.11 数据复制设计524. 词汇表535. 历史数据处理531. 引言引言是对这份数据库设计说明书概览，是为了帮助阅读者了解这份文档是怎样编写，而且应该怎样阅读、了解和解释这份文档。1.1 编写目标说明这份数据库设计说明书是为哪份软件产品编写，开发这个软件产品意义、作用和最终要达成意图。经过这份数据库设计说明书详尽正确地描述了该软件产品数据库结构。假如这份数据库设计说明书只和整个系统某一部分相关系，那么只定义数据库设计说明书中说明那个部分或子系统。1.2 项目起源具体说明本软件开发项目标全部风险负担者，和各自在本阶段所需要负担关键风险，首要风险负担者包含： 任务提出者； 软件开发者； 产品使用者。1.3 文档约定描述编写文档时所采取多种排版约定。排版约定应该包含： 命名方法； 提醒方法； 通配符号： 等等。1.4 预期读者和阅读提议列举本数据库设计说明书所针正确多种不一样预期读者，比如，可能包含： 开发人员； 项目经理； 测试人员； 文档编写人员。而且描述了文档中，其它部分内容及其组织结构，而且针对每一类读者提出最适合文档阅读提议。1.5 参考资料列举编写需求规格说明书时所用到参考文件及资料，可能包含； 本项目标协议书； 上级机关相关本项目标批文； 本项目已经同意计划任务书； 用户界面风格指导； 开发本项目时所要用到标准； 系统规格需求说明； 使用实例文档； 属于本项目标其它已发表文件； 本数据库设计说明书中所引用文件、资料； 相关软件产品数据库设计说明书； 等等。为了方便读者查阅，全部参考资料应该按一定次序排列。假如可能，每份资料全部应该给出： 标题名称； 作者或协议签约者； 文件编号或版本号； 发表日期或签约日期； 出版单位或资料起源。2. 数据库命名规则完整而且清楚说明本数据库命名规则，在南京市交通局信息化数据库建设规范中已经给出了一个完整数据库命名规则，开发者应遵守实施，假如本数据库命名规则和该规范不完全一致，应作出解释。3. 数据库设计说明3.1 数据库逻辑设计数据库设计人员依据软件需求分析汇报，创建和数据库相关实体关系图(E-R图)。如采取面对对象分析和设计方法，则此处实体相当于类。在此处，应给出逻辑设计完整E-R图。3.2 数据库物理设计在此处应给出完整数据库物理结构E-R图。开发者应依据逻辑设计结果，进行数据库物理设计，并对表结构进行规范化处理(第一范式，第二范式，第三范式)。3.3 数据库分布数据库分布采取一张表格进行描述，其格式以下：数据库编号数据库管理系统名称数据库管理系统版本号数据库英文名称数据库汉字名称数据库安装物理位置其中： 数据库编号给出本系统中指定数据库次序编号。若本系统中只有一个数据库，则本项内容不需要描述，本表内容也只有一行。说明： 在一个系统中可能安装若干个相同或不一样数据库管理系统，一个数据库管理系统也可能安装一个或多个数据库。 数据库管理系统名称给出本系统中指定数据库管理系统商品名称。若本系统中只有一个数据库管理系统，则本项内容不需要描述。 数据库管理系统版本号给出本系统中指定数据库管理系统版本号。若本系统中只有一个版本数据库管理系统，则本项内容不需要描述。 数据库英文名称给出本数据库英文名称，该名称是在应用软件中实际使用名称，必需符合南京市交通局信息化数据库建设规范中相关命名规范。 数据库汉字名称给出本数据库汉字名称，该名称是本数据库英文名称说明。 数据库安装物理位置给出本数据库安装实际位置，必需描述清楚该位置是在那个物理设备哪一个逻辑存放设备上，和存放文件名称。3.4 基表设计每个基表采取一张表格进行描述，其格式以下：数据库编号：基表编号：基表英文名称：基表汉字名称：字段编号英文字段名汉字字段名字段类型备注说明：其中 数据库编号含义同上。 基表编号给出本基表次序编号。 基表英文名称给出本基表英文名称，该名称是在应用软件中实际使用名称，必需符合命名规范。 基表汉字名称给出本基表汉字名称，该名称是本基表英文名称说明。 字段编号该基表中，各个字段次序编号。 英文字段名该基表中，各个字段英文名称，该名称必需符合南京市交通局信息化数据库建设规范中相关命名规范。 汉字字段名该基表中，各个字段汉字名称，该名称是英文字段名说明。 字段类型该基表中，各个字段类型；假如需要，在说明类型时，还需要说明字段长度。 备注该基表中，各个字段相关限制性说明，需要描述内容可能包含：n 值域；n 缺省值；n 空字段限制；n 显示格式和小数位数；n 有效性规则和约束；n 标题；n 等等 说明说明部分相关本表、必需描述清楚问题，需要描述内容可能包含：n 主关键字；n 索引、排序方法和类型；n 触发器；n 数据复制；n 等等3.5 视图设计每个视图采取一张表格进行描述，其格式以下：数据库编号：视图编号：视图英文名称：视图汉字名称：相关基表和视图：字段编号英文字段名汉字字段名字段类型字段源备注说明：其中： 数据库编号含义同上。 视图编号给出本视图次序编号。 视图英文名称给出本视图英文名称，该名称是在应用软件中实际使用名称，必需符合命名规范。 视图汉字名称给出本视图汉字名称，该名称是本视图英文名称说明。 相关基表和视图列出建立该视图时，所用到基表和视图。 字段编号该视图中，各个字段次序编号。 英文字段名该视图中，各个字段英文名称，该名称必需符合南京市交通局信息化数据库建设规范中相关命名规范。 汉字字段名该视图中，各个字段汉字名称，该名称是英文字段名说明。 字段类型该视图中，各个字段类型；假如需要，在说明类型时，还需要说明字段长度。 字段源该视图中，各个字段起源，即该字段原来是那个表或那个视图中那个字段；在一些情况下，字段可能来自一个特定表示式。 备注该视图中，各个字段相关限制性说明，包含：n 值域；n 缺省值；n 空字段限制；n 显示格式和小数位数；n 有效性规则和约束；n 标题；n 等等。 说明说明部分相关本视图、必需描述清楚问题，需要描述内容可能包含：n 索引；n 权限；n 等等3.6 索引设计每个数据库全部采取一张表格进行描述，其格式以下：数据库编号：索引编号基表名称索引名称字段集名称备注其中： 数据库编号含义同上。 索引编号给出本项索引次序编号。 基表名称给出本项索引所在基表名称。 索引名称给出本项索引名称。 字段集名称给出本项索引所在字段名称或字段集名称。 备注描述相关本项索引中，其它需要说明事项，比如：排序方法、等等。3.7 完整性约束每个数据库完整性约束采取一张表格进行描述，其格式以下：数据库编号：索引编号基表名称索引名称字段集名称备注其中： 数据库编号含义同上。 约束编号给出本项完整性约束次序编号。 完整性约束名给出本项完整性约束名称。 基表名给出本项完整性约束所在基表名称。 字段名给出本项完整性约束所在字段名称。 约束表示式给出本项完整性约束逻辑表示式。 备注描述相关本项完整性约束中，其它需要说明事项。3.8 授权设计每个数据库授权采取一张表格进行描述，其格式以下：数据库编号：授权编号用户名称对象名称权限备注其中： 数据库编号含义同上。 授权编号给出本项授权次序编号。 用户名称给出本项授权用户名称，这里用户不一定是具体用户，也能够是用户组。 对象名称给出本项授权对象名称，比如：基表、字段、等等。必需注意到，一个用户可能存在多项授权，应该逐项描述。 权限被授权用户在该对象上拥有访问权限，比如：查询权、修改权、等等。 备注描述相关本项授权中，其它需要说明事项。3.9 触发器设计 数据库编号含义同上。 触发器编号给出本触发器次序编号。 触发器英文名称给出本触发器英文名称，必需符合南京市交通局信息化数据库建设规范中相关命名规范。 触发器汉字名称给出本触发器汉字名称，该名称是本触发器英文名称说明。 触发器条件给出该触发器产生触发条件。 触发器结果给出该触发器被触发后所实施动作内容。3.10 存放过程设计每个数据库授权采取一张表格进行描述，其格式以下：数据库编号：存放过程编号：存放过程英文名称：存放过程汉字名称：存放过程内容：说明：其中： 数据库编号含义同上。 存放过程编号给出本存放过程次序编号。 存放过程英文名称给出本存放过程英文名称，该名称是在应用软件中实际使用名称，必需符合命名规范。 存放过程汉字名称给出本存放过程汉字名称，该名称是本存放过程英文名称说明。 存放过程内容给出该存放过程算法或描述具体内容，假如需要，应该辅以步骤图说明。 说明描述本存放过程需要说明部分事项。3.11 数据复制设计每项数据复制采取一张表格进行描述，其格式以下：数据复制编号：复制英文名称：复制汉字名称：源数据库编号：目标数据库编号：复制说明：实施方法：源数据库名称目标数据库名称基表名称字段名称基表名称字段名称备注：其中： 数据复制编号给出本数据复制次序编哥 数据复制英文名称给出本数据复制英文名称，该名称是在应用软件中实际使用名称，必需符合命名规范。 数据复制汉字名称给出本数据复制汉字名称，该名称是本数据复制英文名称说明。 源数据库编号作为复制数据源数据库编号，编号含义同上。 目标数据库编号作为复制目标数据库编号，编号含义同上。 复制说明给出该复制具体描述，假如需要，应该辅以示意图说明。 实施方法给出该复制实施方法，描述时应该说明： 自动实施必需说明实施周期或实施条件。 调用实施必需说明被那个模块调用，和是手动调用，还是条件调用。 源数据库名称给出对应源数据库编号源数据库名称。 目标数据库名称给出对应目标数据库编号目标数据库名称。 基表名称分别给出源数据库和目标数据库中，进行对应复制源基表名称和目标基表名事例。 字段名称分别给出源基表和目标基表中，进行对应复制源字段名称和目标字段名称。 备注描述本复制中需要说明部分特殊事项。4. 词汇表列出本文件中用到专业术语定义，和相关缩写定义(如有可能，列出相关外文原词)。为了便于非软件专业或非计算机专业人士(比如：文档编写人员等等。)阅读数据库设计说明书，要求使用非软件专业或非计算机专业术语进行描述。所以这里所指专业术语，是指业务层面上专业术语，而不是软件专业或计算机专业术语。不过，对于无法回避软件专业或计算机专业术语，也应该列入词汇表，而且加以正确定义。5. 历史数据处理严格说来，历史数据处理并不属于数据库设计范围。不过对于大多数数据库来说，假如历史数据处理不妥，少则数月、多则数年，最终将使数据库无法正常运行。这段时间长短取决于数据库设计容量大小，和数据流强度(即在单位时间内进入数据库数据统计数量)高低。所以应该设计专门归档数据库，并依据历史数据需要保留备查时间长短，定时将历史数据转移到归档数据库中。设计归档数据库时，需要依据具体情况进行考虑，下面列出部分可能需要考虑内容： 历史数据需要备查时间长短。 数据转移周期时间单位比如：日、周、旬、月、季、年、等等。 数据转移方法比如：手动、自动、条件、等等。 历史数据保留细节多数情况下，归档历史数据并不需要保留全部细节，能够去掉部分细节，采用压缩归档处理方法降低归档数据库占用空间。注意：假如压缩数据时，去掉了不该去掉细节，将是无可挽回。 其它需要说明问题