Sql語句轉Markdown格式表格——sql2markdown

實際工作中，經常要用到數據字典。在項目初期維護數據字典很容易，但隨着項目的推進，數據庫結構的改動，這項維護工作變得越來越困難。如果你的數據庫結構中的備註寫的夠全，那麼直接將sql語句導出成爲markdown表格肯定會讓數據字典維護工作變得更加輕鬆。導出的內容可以在markdown編輯器中顯示成優美的markdown格式，然後拷貝到文檔中心，輕而易舉。

所以，我使用php寫了一個小工具，可以將dump出來的sql建表語句直接轉成markdown。
直接上項目地址：https://github.com/wowo-zZ/sql2markdown

使用方法

1. clone項目到本地，進入項目，新建sql（輸入用到的sql文件）、output（markdown輸出文件）目錄；
2. 導出sql建表語句到文件，保存到sql文件夾中，樣例如下所示：

CREATE TABLE `blog` (
  `id` int(10) NOT NULL AUTO_INCREMENT,
  `title` varchar(255) NOT NULL,
  `uid` int(10) NOT NULL,
  `content` text NOT NULL,
  `abstract` varchar(256) NOT NULL DEFAULT '',
  `tags` varchar(60) DEFAULT '',
  `gmt_create` int(10) NOT NULL,
  `gmt_modified` int(10) NOT NULL,
  `author` varchar(60) NOT NULL DEFAULT '路人甲',
  `visit_times` int(11) DEFAULT '0' COMMENT '訪問次數',
  `des` varchar(128) NOT NULL DEFAULT '該文暫無簡介',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=91 DEFAULT CHARSET=utf8;
...

3. 修改convert.php，將其中的sql目錄和output目錄的文件名換成你的：
   
4. 在項目目錄運行php convert.php，即可在output文件夾下看到輸出的markdown文件，拿去用吧~