爽。。。一键导出 MySQL 表结构，告别手动梳理表结构文档了。。。

范星焱

背景

系统需要交付，客户要求提供交维材料，包括系统的表结构，安排开发人员进行梳理，效率比较慢，遂自己花点时间捣鼓一下，发现有此插件，记录一下方便与同事分享
前提条件 必须有 go语言环境，有的话直接看第二点

一、安装 go语言环境

1、检查本机是否安装 go

1. go version

复制代码

2、如果没有，安装 go ,我使用的是 mac,直接使用

1. brew install go

复制代码

安装，也可以去 go官方网站下载安装包进行安装
3、安装完成之后需要进行配置环境变量

1. export PATH=$PATH:/usr/local/go/bin
2. export GOPATH=$HOME/go
3. export PATH=$PATH:$GOPATH/bin

复制代码

安装完成之后使用 go version 进行验证，如下结果说明 go安装成功

二、下载 mysql_markdown插件，并使用

1、插件官方地址

[https://github.com/alicfeng/mysql_markdown]
2、建议直接下载发布版本，我是直接检出最新的代码

[https://github.com/alicfeng/mysql_markdown/releases]
3、检出代码，并编译安装

1. git clone https://github.com/alicfeng/mysql_markdown.git
2. cd mysql_markdown
3. go get "github.com/go-sql-driver/mysql"
4. go build -o /usr/local/bin/mysql_markdown mysql_markdown.go    #这个/usr/local/bin/安装路径自己随意
5. chmod +x /usr/local/bin/mysql_markdown

复制代码

执行go get "github.com/go-sql-driver/mysql"  可能会报超时，请修改 golang代理，原因是访问官方仓库时超时

1. export GOPROXY=https://goproxy.cn,direct

复制代码

4、查看命令

1. ./mysql_markdown_mac --help
3. flag needs an argument: -h
4. Usage: mysql_markdown [options...]
5. --help  This help text
6. -h      host.     default 127.0.0.1
7. -u      username. default root
8. -p      password. default root
9. -d      database. default mysql
10. -P      port.     default 3306
11. -c      charset.  default utf8
12. -o      output.   default current location
13. -t      tables.   default all table and support ',' separator for filter, every item can use regexp
14. -l      language. default cn,support: cn,en

复制代码

5、使用命令,注意参数选项和参数值要空一格

1. $ ./mysql_markdown -h 192.168.xxx.xxx -P 3306 -u root -p yourpasswd -d yourdatabase

复制代码

然后当前目录下会生成一个yourdatebase_2023xxx.md文件。使用 md软件打开查看，通过 Typora查看或转成 docx

来源:https://www.cnblogs.com/lunzi1992/p/17750933.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！