使用SQL文件自动生成数据库文档

0x00 原由

来新公司实习刚过一周时间，一开始都在尝试看项目代码，数据库表结构等，由于没有完备的文档，因此看起来仍是至关困难的，也是由于看数据库时，每次须要一张表一张表的翻，很是麻烦，就想着写个脚本经过SQL文件生成数据库文档，并且当前比较流行markdown，因此就为SQL文件生成了md格式的数据库文档，因而就有了该脚本。

0x01 脚本介绍

目录结构：

md/
FileParserClass.py
MarkdownBuildClass.py
build.py
README.md

其中生成的md文档将保存到md目录下.
FileParserClass.py文件实现从SQL文件中获取数据库表结构
MarkdownBuildClass.py文件为上面文件中获取到的数据库表结构加入md语法
build.py文件为运行文件，运行该文件，便可实现文档生成。
README.md为脚本使用说明。

0x02 使用实例

SQL文件图：

生成的md文件图：

解析后的文件图：

0x03 GitHub 目录

传送门：https://github.com/2liang/AutoBuildDocFromDB

0x04 BUG反馈

由于个人测试SQL文件比较简单，并且测试的SQL文件比较少，不免其中出现问题，若有遇到BUG，还但愿可以发我邮箱。邮箱：usntring@163.com

原文做者：我才是二亮
原文连接：http://www.2liang.me/archives/264
转载必须在正文中标注并保留原文连接、做者等信息。

[4]: https://github.com/2liang/AutoBuildDocFromDB