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

pepperwang 发布于2019-07-24 18:31 / 3290人阅读

摘要：脚本介绍目录结构其中生成的文档将保存到目录下文件实现从文件中获取数据库表结构文件为上面文件中获取到的数据库表结构加入语法文件为运行文件，运行该文件，即可实现文档生成。为脚本使用说明。

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数据库自动备份

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/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