使用SQL文件自動生成數據庫文檔

pepperwang 發布于2019-07-24 18:31 / 3288人閱讀

摘要：腳本介紹目錄結構其中生成的文檔將保存到目錄下文件實現從文件中獲取數據庫表結構文件為上面文件中獲取到的數據庫表結構加入語法文件為運行文件，運行該文件，即可實現文檔生成。為腳本使用說明。

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

云服務器 GPU云服務器 SQL文件使用什么數據庫生成sql文件 sql數據庫自動備份 sql2000數據庫自動備份

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/37802.html

MyBatis Generator：Mybatis代碼生成器

摘要：一的官方資料官方文檔源碼二介紹大致的意思是可以幫助所有版本的和以上版本的生成代碼。其中目前最新的版本可以使用。指定生成一系列對象的環境。定義了生成的注釋形式。與生成的實體相關。生成接口和類以達到輕易使用生成的模型和映射文件的目的。一：MyBatis Generator的官方資料 MyBatis Generator官方文檔github源碼：MyBatis Generator (MBG)...

SimonMa 2019-08-19 10:41 評論0 收藏0
從0開始構建一個屬于你自己的PHP框架

摘要：如何構建一個自己的框架為什么我們要去構建一個自己的框架可能絕大多數的人都會說市面上已經那么多的框架了，還造什么輪子。 showImg(https://segmentfault.com/img/bVNg9F?w=500&h=500); 如何構建一個自己的PHP框架為什么我們要去構建一個自己的PHP框架？可能絕大多數的人都會說市面上已經那么多的框架了，還造什么輪子？。我的觀點造輪子不是目...

vpants 2019-06-27 16:26 評論0 收藏0
SpringBoot非官方教程 | 第五篇：SpringBoot整合 beatlsql

摘要：整合階段由于沒有對的快速啟動裝配，所以需要我自己導入相關的，包括數據源，包掃描，事物管理器等。另外它的中文文檔比較友好。源碼下載參考資料中文文檔 BeetSql是一個全功能DAO工具，同時具有Hibernate 優點 & Mybatis優點功能，適用于承認以SQL為中心，同時又需求工具能自動能生成大量常用的SQL的應用。 beatlsql 優點開發效率無需注解，自動使用大...

microelec 2019-08-16 10:44 評論0 收藏0