最近,协助公司 ISO 评审,整理相关项目的数据库设计文档。学到了数据库设计文档的相关规范 和 Navicat导出Word数据表的做法,在此做详细说明,方便后面的类似工作借鉴。
注意:通过本博客,你可以了解数据库设计文档该如何编写,但是该文档的编写却是个耗时且机械重复的过程。因此,我写了一个项目,通过该项目,你可以一键生成数据库设计文档,甚至支持自定义字段样式。地址如下:https://blog.csdn.net/qq_41057885/article/details/127090006
一、 文档规范
1. 文档命名,规范如下图:
2. 内容规范
模板我已上传至CSDN的资源。某某项目_数据库设计文档.docx_navicat导出word-互联网文档类资源-CSDN下载
二、Navicat导出Word表格
1. 查询出表结构
打开目标数据库(test)同级的 information_schema 数据库,执行以下SQL即可。
注意:test为数据库名称,user为表名
SELECT
`COLUMNS`.ORDINAL_POSITION AS '序号',
`COLUMNS`.COLUMN_NAME AS '字段名',
`COLUMNS`.COLUMN_TYPE AS '类型(长度)',
`COLUMNS`.NUMERIC_PRECISION AS '精度',
`COLUMNS`.NUMERIC_SCALE AS '小数位数',
`COLUMNS`.COLUMN_DEFAULT AS '默认值',
IF( `COLUMNS`.IS_NULLABLE = 'YES', '√', '' ) AS '允许空',
IF( `COLUMNS`.COLUMN_KEY = 'PRI', '√', '' ) AS '主键',
`COLUMNS`.COLUMN_COMMENT AS '说明'
FROM
`TABLES` INNER JOIN `COLUMNS` ON `COLUMNS`.TABLE_SCHEMA = `TABLES`.TABLE_SCHEMA
AND `COLUMNS`.TABLE_NAME = `TABLES`.TABLE_NAME
WHERE
`TABLES`.TABLE_SCHEMA = 'test' AND `TABLES`.TABLE_NAME = 'user'
2. 复制到word
复制完成后,打开Excel,粘贴到Excel表格上
再次全选,复制到Word上,选择 “使用目标样式”
3. 获取表注释
SELECT TABLE_COMMENT
FROM `TABLES`
WHERE TABLE_SCHEMA = 'test' AND TABLE_NAME = 'user'
4. 表头背景颜色设置:选中表头--->右键--->表格属性--->边框和底纹。