使用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