1.为何生成文档

     在项目开发中,文档对于一个项目是多么重要的存在,而其中,对数据库的描述也是必须的存在,今天记录一下生成数据库文档的一个途径。


2.文档书写工具

     我最近在用 在线开发文档协作在线文档协作工具,里面文档书写格式是 markdowm,这当然也是程序员喜欢的文档格式之一。所以我一下就爱上了他。

数据库表文档生成,markdown(图1)


下面是,数据库文档示例;

数据库表文档生成,markdown(图2)


界面还算很简洁大方。我个人是很喜欢这种风格的。


3.数据库生成

数据库表文档生成,markdown(图3)

由上图左边的文本格式可以看出,生成表格需要的格式。


4.使用 Navicat 15 for MySQL 

  这个我相信都不陌生。数据库管理工具。可视化的图形界面管理数据库。


来到这一步,我们需要先查询每个表的字段,和我们需要的信息!

USE information_schema;


SELECT
    C.COLUMN_NAME AS '字段名',
    C.COLUMN_TYPE AS '数据类型',
    C.IS_NULLABLE AS '允许为空',
    C.EXTRA AS 'PK',
    C.COLUMN_COMMENT AS '字段说明'
FROM
    COLUMNS C
INNER JOIN TABLES T ON C.TABLE_SCHEMA = T.TABLE_SCHEMA
AND C.TABLE_NAME = T.TABLE_NAME
WHERE
    T.TABLE_SCHEMA = '数据库名' and T.TABLE_NAME='表名'


由上面可以看出,C.数据类型  我们可以定制输出,看个人需要。

点击查询后,我得到了下面这图:

数据库表文档生成,markdown(图4)

得到结果集,可以看见,这是我们希望的数据,那导出就好了,

数据库表文档生成,markdown(图5)

数据库表文档生成,markdown(图6)

数据库表文档生成,markdown(图7)

数据库表文档生成,markdown(图8)

如果想知道字段分割,文本识别符号是哪个位置,自己可以导出其他符号试试。


点击下一步->开始,之后我们会得到:

数据库表文档生成,markdown(图9)


在我们选中的位置可以看到文件,打开:

数据库表文档生成,markdown(图10)

我们比较一下上面要求的 markdown 格式,发现只需要在每一行首位加上 |  就可以一样了。之后就是copy,


5.总结

其实就是利用导出格式控制,得到了符合markdowm的格式而已。如果你连最后那步都不想做,随便写个程序也能ok。加油!