1.前言

作为一名技术人员，少不了接触数据库，那么当遇到一个旧项目数据库表比较多，怎么快速的导出表结构，形成文档方便后续跟进呢？今天我给大家安利一个好用的工具mysql_markdown。

2.工具官网代码地址

https://github.com/alicfeng/mysql_markdown

它是一款基于 go 语言编写的一个命令行工具，适用于 Linux、Mac、Windows等平台。

3.直接部署（小白推荐方式）

发布包从官网代码直接下载安装

https://github.com/alicfeng/mysql_markdown/releases

下载稳定版本

4.编译部署

有时候我们需要使用工具新特性，可以自行编译此工具，这里也介绍下如何编译最新代码。

4.1部署Go环境

• 官网下载Go安装包

官网
https://golang.google.cn/dl/下载go安装包，选择合适的平台下载安装即可。

Go官网

• 这里我是macos平台，下载后默认安装在/usr/local/go/目录下。

• 配置环境变量，追加环境变量。

$ vim ~/.bash_profile

export GOROOT=/usr/local/go/
export GOBIN=$GOROOT/bin

export PATH=$GOBIN:$PATH

• 生效环境变量

$ source  ~/.bash_profile

• 验证是否生效

$ which go
/usr/local/go/bin/go

4.2编译工具

编译安装（有编译知识的童鞋可以自行编译）

$ 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
$ chmod +x /usr/local/bin/mysql_markdown

5.工具语法

$ ./mysql_markdown_mac --help
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

是不是和mysql的语法一样，容易上手。

6.工具实战

下面我以导出mysql表为例，这里注意参数选项和参数值要空一格，切记切记！

$ ./mysql_markdown_mac -h 10.10.10.10 -P 33706 -u root -p kkdd123 -d mysql
1/31 the columns_priv table is making ...
2/31 the db table is making ...
3/31 the engine_cost table is making ...
4/31 the event table is making ...
5/31 the func table is making ...
6/31 the general_log table is making ...
7/31 the gtid_executed table is making ...
8/31 the help_category table is making ...
9/31 the help_keyword table is making ...
10/31 the help_relation table is making ...
11/31 the help_topic table is making ...
12/31 the innodb_index_stats table is making ...
13/31 the innodb_table_stats table is making ...
14/31 the ndb_binlog_index table is making ...
15/31 the plugin table is making ...
16/31 the proc table is making ...
17/31 the procs_priv table is making ...
18/31 the proxies_priv table is making ...
19/31 the server_cost table is making ...
20/31 the servers table is making ...
21/31 the slave_master_info table is making ...
22/31 the slave_relay_log_info table is making ...
23/31 the slave_worker_info table is making ...
24/31 the slow_log table is making ...
25/31 the tables_priv table is making ...
26/31 the time_zone table is making ...
27/31 the time_zone_leap_second table is making ...
28/31 the time_zone_name table is making ...
29/31 the time_zone_transition table is making ...
30/31 the time_zone_transition_type table is making ...
31/31 the user table is making ...
mysql_markdown finished ...

然后你会看到当前目录下会生成一个mysql_20200610_103451.md文件。

Typora打开md文档

7.结束

是不是很简单，生成表结构文档，so easy。你学会了吗？

喜欢本文的童鞋，可以关注+收藏，不明白的地方也可以评论留言。