数据库设计说明模板|江阴雨辰互联

2023年7月27日发(作者：)

数据库设计说明V4.0

标记

数量

XXX

修改单号

标检

批准

会签

签字

XXX

日期

XT-DDD-GF

编制

校对

审核

会签

XXX

数据库设计说明

共 9 页第 1页

中国船舶工业系统工程研究院 XT-DDD-GF

修订记录

版本号修订状态简要说明修订内容和范围

修订日期

修订人批准日期

注：修订记录在体系文件发布后换版时使用，修订状态栏填写：A—增加，M—修改，D—删除

2 XT-DDD-GF

1 范围 ................................................................ 2

1.1 标识 .............................................................. 2

1.2 系统概述 .......................................................... 2

1.3 文档概述 .......................................................... 2

2 引用文档 ............................................................ 2

3 数据库级设计决策 .................................................... 2

4 数据库详细设计 ...................................................... 3

4.1 (数据库设计级别的名称) ............................................ 3

5 用于数据库访问或操纵的软件单元的详细设计 ............................ 4

5.1 (软件单元的项目唯一的标识符，或者一组软件单元的标志符) ............ 4

6 需求可追踪性 ........................................................ 7

7 注释 ................................................................ 7

3 XT-DDD-GF

1 范围

1.1 标识

本条应描述本文档所适用系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号和发布号。

简要说明系统的标识号、发布号、名称、缩略名、版本号。

a) 软件标识号：H/ZHGLYJCRJ-01；

b) 发布号：V01

c) 名称：

d) 缩略名：

e) 版本号：V1.0；

f) 适用系统：

1.2 系统概述

本条应概述本文档所适用系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等：标识当前和计划的运行现场；列出其他有关文档。

分别简要说明系统的用途、软件用途标识需方、用户、开发方等。

a) 需方：

b) 用户：

c) 开发方：

1.3 文档概述

本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。

2 引用文档

本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。示例：

a) 《文档名称1》，编号（若有），编写单位，版本（若有），日期；

b) 《文档名称2》，编号（若有），编写单位，版本（若有），日期。

3 数据库级设计决策

本章应视需要分条给出数据库级设计决策，即数据库的行为设计决策(忽略其内部实现，从用户角度出发描述数据库将怎样运转以满足需求)以及其他影响数据库进一步设计的决策。如果所有这些决策在系统需求或CSCI需求中均是明确的，本章应如实陈述。对应于指定为关键性需求(例如对安全性或保密性需求)的设计决策，应在专门的章条中加以叙述。如果一个设计决策依赖于系统状态或方式，应指明这一2 XT-DDD-GF

依赖性。如果设计决策的部分或全部在定制的或商用的数据库管理系统(DBMS)中进行了描述，本章可以直接引用。本章应给出或引用理解设计所需的设计约定。数据库级设计决策的例子如下：

a) 关于数据库将接收的查询或其他输入以及它将产生的输出(显示、报表、消息、响应等)，包括与其他系统、HWCI、CSCI及用户的接口的设计决策(本文档的5.1.d条指出这项说明应考虑的主题)。如果这一信息的全部或部分在接口设计说明(TDD)中给出，那么可以直接引用。

b) 有关响应每个输入或查询时数据库行为的设计决策，包括数据库将执行件么动作，响应时间和其他性能特性，所选择的方程式/算法/规则，处理和对不允许的输入的处理。

c) 有关数据库/数据文件如何呈现给用户的设计决策(本文档的4.1条标识了这项说明应考虑的主题)。

d) 有关所使用的数据库管理系统(包括名称、版本/发布版)以及为适应需求的变更而引入到数据库内部的灵活性类型的设计决策。

e) 有关数据库应提供的可用性、安全性、保密性和操作连续性的等级和类型的设计决策。

f) 有关数据库的分布(例如客户/服务器)、主数据库文件的更新和维护的设计决策，包括维护一致性、建立同步/重建同步和维持同步、强制完整性和业务规则。

g) 有关备份与恢复的设计决策，包括数据和处理的分布策略，备份和恢复过程中允许的动作，以及对新技术或非标准技术(如视频和声音等)的特殊考虑。

h) 关于重新打包、排序、索引、同步以及一致性的设计决策，包括自动磁盘管理和自动空间同收、优化策略、存储与空间大小以及数据库的规模与继承数据捕获等方面的考虑。

4 数据库详细设计

注：本文档用“数据元素集合”一例来代表在一指定的设计级别(例如概念设计、内部设计、逻辑设计、物理设计)上具有结构(数据元素的编号/次序/分组)的任何实体、关系、模式、字段、表、数组等，用“数据元素”一词来代表在该级别下不具有结构的任何关系、属性、字段、单元(cell)、数据元素等。

4.1 (数据库设计级别的名称)

本条应标识数据库设计级别，并用所选择的设计方法的术语描述数据库的数据元素和数据元素集合。(若适用)这些信息应包括如下内容，它们可按任何适合于所提供信息的顺序提供：

3 XT-DDD-GF

数据库设计中各个数据元素的特征，例如：

1) 名称，标识符：

项目唯一的标识符；

非技术(自然语言)名称；

数据元素名称；

技术名称(如在数据库中字段名)；

缩略名或同义名。

2) 数据类型(字母、数字、整数等)。

3) 大小和格式(如：字符串的长度和标点符号)。

4) 计量单位(如：m等)。

5) 可能值的范围或枚举(如：O一99)。

6) 准确性(正确程度)和精度(有效数位数)。

7) 优先级别、定时、频率、容量、排序以及其他约束条件(例如数据元素是否可以被更新、业务规则是否适用)。

8) 保密性约束。

9) 来源(建立/发送的实体)和接受者(使用，接收的实体)。

i) 数据库设计中的数据元素组合体(记录、消息、文件、数组、显示、报表等)的特征，例如：

1) 名称/标识符：

项目唯一的标识符；

非技术(自然语言)名称；

技术名称(如在代码或数据库中的记录名或数据结构名)；

缩略名或同义名。

2) 数据元素组合体中的数据元素及其结构(编号、顺序和分组)。

3) 介质(例如磁盘)以及在介质上数据元素，数据元素组合体的结构。

4) 显示和其他输出的视听特征(例如颜色、布局、字体、图标和其他显示元素、蜂鸣音和亮度)。

5) 数据元素组合体之间的关系，如分类/存取特征。

6) 优先级、定时、频率、容量、序列及其他约束，例如数据元素组合体是否可以被更新、业务规则是否适用。

7) 保密性约束。

8) 来源(建立/发送的实体)和接受体(使用，接收的实体)。

5 用于数据库访问或操纵的软件单元的详细设计

5.1 (软件单元的项目唯一的标识符，或者一组软件单元的标志符)

4 XT-DDD-GF

本条应该通过项目唯一的标识符来标识软件单元，并且对该单元进行说明。(若适用)这一说明应包括下列信息。本条也可以指定一组软件单元，然后再分条对它们分别进行标识和说明。包含其他软件单元的软件单元，可以引用那些软件单元的说明，而无需在此重复。

a) (若有)单元设计决策，例如所使用的算法等，如果此前尚未选定。

b) 该软件单元设计中的任何约束、限定或非常规特征。

c) 所采用的不同于为该CSCI所指定语言的编程语言及使用它的理由。

d) 如果该软件单元包含过程性命令或是由其组成(例如数据库管理系统(DBMS)中用于定义表和报表的菜单选择，用于数据库访问和操纵的在线DBMS查询，对用于代码自动生成的图形用户接口(GUI)构造器的输入，给操作系统的命令或Shell脚本)，应列出这些过程性命令，并引用解释它们的用户手册或其他文档。

e) 如果该软件单元包含、接收或输出数据，(若适用)应对它的输入、输出以及其他数据元素和数据元素集合进行说明。该软件单元的局部数据应该单独描述，不应该和输入或输出数据混在一起。接口特性可以在此提供，也可以引用接口设计说明(IDD)。如果一指定的接口实体本DBDD没有覆盖(例如，一个外部系统)，但是其接口特性在本(DBDE)描述软件单元时需要提到，则这些特性应作为假设进行描述、或以“当[未提及实体]这样做时，[软件单元]将……”的形式进行描述。本条可引用其他文档(例如数据字典、协议标准、用户接口标准)代替本条的信息描述。(若适用)设计说明应包括如下内容，以适合于所提供信息的任何顺序给出，并应从接口实体角度指出这些特性之间的区别(例如对数据元素的大小、频率或其他特性的不同期望值)：

1) 接口的项目唯一的标识符。

2) (若适用)用名称、编号、修订以及文档引用来标识接口实体(软件单元、配置项、用户等)。

3) 接口实体分配给接口的优先级。

4) 要实现的接口类型(例如实时数据传输、数据的存储和检索等)。

5) 接口实体将提供、储存、发送、访问、接收的各个数据元素的特征。本文档中的4.1.a条标识出了在本说明中需要包含的内容。

6) 接口实体将提供、存储、发送、访问、接收的数据元素组合体(记录、消息、文件、数组、显示、报表等)的特征。本文档中的4.1.b条，标识了本说明中需要包含的内容。

7) 接口实体将用于该接口的通信方法的特征，例如：

5 XT-DDD-GF

项目唯一的标识符；

通信链接/带宽/频率/介质和它们的特征；

消息格式；

流控制(如：序列编号和缓冲区分配)；