GO语言 MySQL 表结构生成 Markdown 文档

前言

软件产品build后，缺乏数据库表结构说明文档，一直想找到一款可以通过mysql数据库实例直接反向生成markdown 文档。

这样的软件很多，今天给大家介绍一款，个人觉得很棒的一款工具，mysql_markdown ，它是一款基于 go 语言编写的一个命令行工具，

适用于 Linux、Mac、Windows 等平台。它是生成数据库表结构说明文档，格式为 markdown。

mysql_markdown.github

mysql_markdown.download

安装-mac os
安装方式

• 安装go

       下载go并安装：

       下载路径：https://golang.org/doc/install?download=go1.15.5.darwin-amd64.pkg

• 下载mysql_markdown并执行go build

# build install
git clone https://github.com/alicfeng/mysql_markdown.git
cd mysql_markdown
sudo go get "github.com/go-sql-driver/mysql"
sudo go build -o /usr/local/bin/mysql_markdown mysql_markdown.go
sudo chmod +x /usr/local/bin/mysql_markdown

• 使用mysql_markdow

# 帮助函数
➜  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 -p 123456 -d user
mysql connected ...
1/5 the demo table is making ...
2/5 the failed_jobs table is making ...
3/5 the user table is making ...
4/5 the org table is making ...
5/5 the users table is making ...
mysql_markdown finished ...

• 执行中遇到问题

go: github.com/go-sql-driver/mysql@v1.5.0: Get "https://proxy.golang.org/github.com/go-sql-driver/mysql/@v/v1.5.0.mod": dial tcp 34.64.4.113:443: i/o timeout

这种情况，正常是网络防火墙对.mod进行了限制，可以通过配置go 代理方式，解决

go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.cn,direct

• md转化成其它格式，推荐使用 typora 工具 它支持如下转换格式

md2pdf
md2html
md2html(without styles)
md2word
md2rtf
md2openOffice
md2Epub
md2latex
md2MediaWiki
md2reStructureText
md2textile
md2OPML
md2png