软件数据库设计报告文档模板.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. 历史数据处理严格说来，历史数据处理并不属于数据库设计范畴。可是对于大多数数据库来说，如果历史数据处理不当，少则数月、多则数年，最终将使数据库无法正常运行。这段时间的长短取决于数据库设计容量大小，以及数据流强度(即在单位时间内进入数据库的数据记录数量)高低。因此应该设计专门的归档数据库，并根据历史数据需要保存备查的时间长短，定期将历史数据转移到归档数据库中。设计归档数据库时，需要根据具体情况进行考虑，下面列出一些可能需要考虑的内容： 历史数据需要备查的时间长短。 数据转移周期的时间单位例如：日、周、旬、月、季、年、等等。 数据转移的方式例如：手动、自动、条件、等等。 历史数据保存的细节多数情况下，归档的历史数据并不需要保存全部细节，能够去掉部分细节，采用压缩归档处理的方法减少归档数据库的占用空间。注意：如果压缩数据时，去掉了不该去掉的细节，将是无可挽回的。 其它需要说明的问题