数据库设计说明

::: {.center}
xx公司

2020-01-01
:::

文档管理

合理地管理主文档,
确保文档版本的及时更新,同时保持备份文档和源文档的一致性。

版本管理


本版本修订日期 2019-08-12 生效日期 2019-08-12


版本 生效日期 变更内容 编制人


V1.0 2020-01-01 初稿编写完成 xx

概述

编写目的

描述该文档的编写目的。

参考资料

列出此文档所参考的文档,如软件需求规格说明、软件设计说明等。

分类

(若有)对存储数据分类进行简要说明(数据可以按照子系统进行划分)。

  • 第全局类数据及其说明
  • 第二类数据及其说明
  • 第三类数据及其说明

使用它的程序

描述对应不同分类的数据,所使用它的外部程序或者业务系统。

约定

描述数据库设计方面的标识约定、设计约定、特殊约定等。

数据定义

全局数据

主要应用范围: 作用: 数据库定义文件: ER图文件:

表结构设计

  1. .1 表一与触发器

    表一结构说明,包括:表名、表说明(内容、作用)、索引、各列属性。
    各列属性,包括:列英文名、列中文名、 数据类型、长度、 列取值含义等。
    触发器列表,包括:名称、说明、定义等。

  2. .2 表二与触发器

    ……

视图设计

  1. .1 视图一

    定义: 用途:

  2. .1 视图二

    ……

存储过程设计

  1. .1 过程一

    定义: 用途: 输入: 输出:

.2 过程二

……

第二类数据

主要应用范围: 作用: 数据库定义文件: ER图文件:

表结构设计

……

视图设计

……

存储过程设计

……

数据库角色定义

第一类角色

角色职能: 角色权限:

第二类角色

……

数据库安全设计

针对数据库安全方面的要求进行的设计,包括保密性、安全性等方面。

数据库备份设计

针对数据的备份要求,描述数据库的备份策略、备份和恢复的手段、备份计划、操作步骤等方面的内容。

内容审核要点:

  • 本文档内容与软件设计文档、软件需求文档是否一致性;
  • 所述内容是否完备;
  • 本文档内容本身是否前后一致;
  • 表结构描述是否清楚明确; (若有)触发器描述是否清楚明确;
    (若有)视图描述是否清楚明确; (若有)存储过程描述是否清楚明确;
  • 数据库角色设置是否清楚合理。
  • 是否满足了安全、备份的要求。

参考

https://www.jianshu.com/p/a7984927cfb9