1.前言

作為一名技術人員，少不了接觸資料庫，那麼當遇到一個舊項目資料庫表比較多，怎麼快速的導出表結構，形成文檔方便後續跟進呢？今天我給大家安利一個好用的工具mysql_markdown。

2.工具官網代碼地址

https://github.com/alicfeng/mysql_markdown

它是一款基於 go 語言編寫的一個命令行工具，適用於 Linux、Mac、Windows等平台。

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

發布包從官網代碼直接下載安裝

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

工具-MySQL資料庫表結構快速導出成MarkDown文檔

下載穩定版本

4.編譯部署

有時候我們需要使用工具新特性，可以自行編譯此工具，這裡也介紹下如何編譯最新代碼。

4.1部署Go環境

官網下載Go安裝包

官網
https://golang.google.cn/dl/下載go安裝包，選擇合適的平台下載安裝即可。工具-MySQL資料庫表結構快速導出成MarkDown文檔

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文件。工具-MySQL資料庫表結構快速導出成MarkDown文檔