MySQL 表结构生成 Markdown 文档工具mysql_markdown

398次阅读
没有评论

共计 578 个字符,预计需要花费 2 分钟才能阅读完成。

背景
在实施软件工程的时候,当要将某一版本归档时,需要汇总的文档要求还是比较高的、各类文档齐全,包括项目架构、项目安装、接口等文档,而数据库表结构说明文档亦属于其一。记得很早之前想找一个可以导出 MySQL 数据库表结构说明文档的工具,生态上的这种工具是有的、只不过并没有一个使我比较满足的。当然、看个人所需,我需要一个可以导出 markdown 文档的。

于是 找到了 mysql_markdown 这个工具。它是一款基于 go 语言编写的一个命令行工具,适用于 Linux、Mac、Windows 等平台。那么它可以做什么?他只有一个功能、就是生成数据库表结构说明文档,格式为 markdown。

GitHub地址

简单用法

# 帮助函数
➜  mysql_markdown -h
flag needs an argument: -h
Usage: mysql_markdown [options...]
--help  This help text
-h      host.     default 127.0.0.1
-u      username. default root
-p      password. default root
-d      database. default mysql
-P      port.     default 3306
-c      charset.  default utf8
-o      output.   default current location

# 简单使用
➜ mysql_markdown -d test

正文完
 0
Eric chan
版权声明:本站原创文章,由 Eric chan 于2020-04-28发表,共计578字。
转载说明:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。