小编点评

**背景** 需要交付的交维材料包括系统的表结构，但效率比较慢，遂自己花点时间捣鼓一下，发现有此插件，记录一下方便与同事分享前提条件。 **安装步骤** 1. **安装 go语言环境** - 直接使用brew install go 安装 - 或去 go官方网站下载安装包进行安装 2. **检查本机是否安装 gogo version2** - 使用 go version 进行验证 3. **安装 go语言环境** - 使用brew install go 安装 4. **配置环境变量** - 使用 echo 将 GOPATH变量设置为 `$GOPATH:/usr/local/go/bin` 5. **编译安装 git clone** - git clone https://github.com/alicfeng/mysql_markdown.gitcd mysql_markdowngo get \"github.com/go-sql-driver/mysql\"go build -o /usr/local/bin/mysql_markdown mysql_markdown.go 6. **设置环境变量** - 使用 `export` 命令添加以下环境变量： ```bash GOPROXY=https://goproxy.cn,direct4 ``` 7. **运行程序** - 使用 `./mysql_markdown -h 192.168.xxx.xxx -P 3306 -u root -p yourpasswd -d yourdatabase` 命令运行程序

正文

背景

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

前提条件 必须有 go语言环境，有的话直接看第二点

一、安装 go语言环境

1、检查本机是否安装 go

go version

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

brew install go 

安装，也可以去 go官方网站下载安装包进行安装

3、安装完成之后需要进行配置环境变量

export PATH=$PATH:/usr/local/go/bin
export GOPATH=$HOME/go
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、检出代码，并编译安装

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

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

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

4、查看命令

./mysql_markdown_mac --help

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
-t      tables.   default all table and support ',' separator for filter, every item can use regexp
-l      language. default cn,support: cn,en

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

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

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