使用 Navicat 生成数据库设计文档

使用 Navicat 生成数据库设计文档

参考来源

本文参考来源于微信公众号：小陈玩AI

效果

先看简单的效果图，如果效果合适，大家在进行测试使用，不合适直接撤退，也不浪费时间。

效果图：

随后在docx文档中生成目标字段的表格，选中全部(ctrl+a)进行复制(ctrl+c)，或全选之后右键复制为制表符分隔值（字段名和数据），粘贴到你刚刚复制的表格中，效果图如下：

实现步骤：

解决思路

1、解决的原理是利用 MySQL 中的 information_schema 数据库。
2、这个数据库提供了 MySQL 服务器上所有数据库的信息。
3、其中，COLUMNS 表提供了所有数据库表的字段信息，包括字段名称、字段类型和是否允许为 NULL 等。

查询单表

下面是 SQL 语句，可以根据自己的实际需求进行相应调整。

SELECT
 COLUMN_NAME AS 字段名称,
 COLUMN_TYPE AS 字段类型,
 (CASE IS_NULLABLE WHEN 'NO' THEN '否' ELSE '是' END) AS 是否为空,
 (CASE COLUMN_KEY WHEN 'PRI' THEN '主键' WHEN 'MUL' THEN '外键' ELSE '' END) AS 主外键,
 COLUMN_COMMENT AS 描述 
FROM
 information_schema.COLUMNS
WHERE
 TABLE_SCHEMA = '你的数据库名'
 AND TABLE_NAME = '你的数据库表名'
ORDER BY
 ORDINAL_POSITION;

这个 SQL 语句主要是用于获取指定数据库中指定数据库表的字段名称、字段类型、是否为空、主外键和描述等信息。

查询多表

SET @current_table = '';

SELECT
  IF(@current_table <> TABLE_NAME, @current_table := TABLE_NAME, '') AS 表名,
 COLUMN_NAME AS 字段名称,
 COLUMN_TYPE AS 字段类型,
 (CASE IS_NULLABLE WHEN 'NO' THEN '否' ELSE '是' END) AS 是否为空,
 (CASE COLUMN_KEY WHEN 'PRI' THEN '主键' WHEN 'MUL' THEN '外键' ELSE '' END) AS 主外键,
 COLUMN_COMMENT AS 描述
FROM
 information_schema.COLUMNS 
WHERE
 TABLE_SCHEMA = '你的数据库名' 
ORDER BY
 TABLE_NAME,
 ORDINAL_POSITION;

修改后的查询会一次性返回指定数据库中所有表的字段信息。效果如下：

导出excel

1、点击工具栏中的 导出结果 按钮。

2、点击 导出当前的结果 按钮。

3、选择 Excel 文件（2007 或更高版本）（.xlsx） 一项，然后点击 >> 按钮跳到最后一步。

4、点击 开始 按钮。

5、点击打开就能看到了