数据库结构说明如何验收

发布时间: 更新时间:
举报

建站项目验收时,数据库结构说明常被忽略,导致后期维护、迁移或二次开发时无人能说清表与表的关系。如果合同约定交付物包含技术文档,就应把数据库结构说明列为可核对项。以下从表关系、关键字段、约束、编码和迁移脚本五个方面,说明验收时看什么、怎么记录,示例均需脱敏,真实备份不直接作为公开文档。

表关系:用脱敏示例核对关联逻辑

验收时要求交付方提供表关系图或文字说明,标明每张表的用途及表间关联方式。例如用户表与订单表通过用户编号关联,订单表与订单明细表通过订单编号关联。示例中的表名、字段名和编号应替换为占位符,不得出现真实客户数据。

核对方法:随机选一条业务链路,按说明从主表查到明细表,确认关联字段一致。若说明缺失或关联字段对不上,记录为遗留项。

关键字段:记录名称、类型与用途

关键字段指业务运行不可缺少的字段,如订单状态、金额、创建时间。验收时要求交付方列出字段名称、数据类型、是否允许为空、用途说明。示例值用“示例值”代替,不写真实金额或个人信息。

核对方法:对照实际页面或功能,确认说明中的字段能支撑业务展示。例如订单状态字段应能对应后台可选的几种状态,金额字段应说明精度和舍入规则。

约束与编码:确认规则和字符集

约束包括主键、不重复约束字段、非空约束和外键。验收时要求说明每张表的主键是什么,哪些字段有不重复性要求,哪些字段不允许为空。编码指数据库字符集和排序规则,应写明统一使用的字符集,避免中英文混排出现乱码。

核对方法:抽取一张核心表,检查说明中的主键和不重复约束字段是否与实际数据一致。字符集可要求交付方演示插入一条含中文和符号的记录,确认显示正常。

迁移脚本:核对版本与执行顺序

迁移脚本用于在不同环境间同步表结构。验收时要求交付方提供脚本清单,标明每个脚本的版本号、执行顺序和用途。脚本中不得包含真实数据,只能包含结构变更语句。

核对方法:在测试环境按清单顺序执行一遍,确认无报错且表结构与说明一致。若脚本缺失或顺序不明,记录为遗留项,并要求补充版本说明。

公开文档与真实备份的边界

数据库结构说明属于技术文档,可以脱敏后随项目交付;真实数据备份包含客户信息,不应直接作为公开文档或示例附件。验收时应确认交付文档中不含真实备份文件,备份的存放和恢复方式另行约定。

核对方法:检查文档附件列表,确认只有结构说明和脱敏示例,没有数据导出文件。若发现真实备份混入,应要求移除并记录处理结果。