使用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文件图:

SQL文件图

生成的md文件图:

生成的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

二话区块链
区块链使我快乐。

哈哈哈

2.5k 声望
52 粉丝
0 条评论
推荐阅读
以太坊标准令牌系列之同质化令牌ERC20
众所周知,以太坊在现阶段最大的应用就是令牌发行,而在以太坊中有很多类型的令牌,最著名的当属ERC20了,但是对于其他几种令牌类型,可能还有一些朋友不知道,所以最近规划了一个系列,就是以太坊标准令牌系列。

我才是二亮1阅读 3.4k

基于Sanic的微服务基础架构
使用python做web开发面临的一个最大的问题就是性能,在解决C10K问题上显的有点吃力。有些异步框架Tornado、Twisted、Gevent 等就是为了解决性能问题。这些框架在性能上有些提升,但是也出现了各种古怪的问题难以...

jysong6阅读 4k评论 3

又一款眼前一亮的Linux终端工具!
今天给大家介绍一款最近发现的功能十分强大,颜值非常高的一款终端工具。这个神器我是在其他公众号文章上看到的,但他们都没把它的强大之处介绍明白,所以我自己体验一波后,再向大家分享自己的体验。

良许6阅读 1.9k

初学后端,如何做好表结构设计?
这篇文章介绍了设计数据库表结构应该考虑的4个方面,还有优雅设计的6个原则,举了一个例子分享了我的设计思路,为了提高性能我们也要从多方面考虑缓存问题。

王中阳Go4阅读 1.8k评论 2

封面图
FastAPI性能碾压Flask?
不止一次的听过,FastAPI性能碾压Flask,直追Golang,不过一直没有测试过,今天闲着没事测试一下看看结果。不知道是哪里出了问题,结果大跌眼镜。

二毛erma02阅读 10.3k评论 3

封面图
Vue+Express+Mysql全栈项目之增删改查、分页排序导出表格功能
本文记录一下实现一个全栈项目,前端使用vue框架、后端使用express框架、数据库使用mysql。此项目的意义不仅仅有助于我们复习nodejs相关知识、更有助于带前端新人,使其快速从整体全局角度中,理解常规后台管理系...

水冗水孚4阅读 2.6k

MySQL百万数据深度分页优化思路分析
一般在项目开发中会有很多的统计数据需要进行上报分析,一般在分析过后会在后台展示出来给运营和产品进行分页查看,最常见的一种就是根据日期进行筛选。这种统计数据随着时间的推移数据量会慢慢的变大,达到百万...

一个程序员的成长7阅读 954

封面图

哈哈哈

2.5k 声望
52 粉丝
宣传栏