2liang / autobuilddocfromdb

使用SQL文件自动生成markdown格式的数据库文档。

AutoBuildDocFromDB

使用SQL文件自动生成markdown格式的数据库文档。

使用说明

1. 使用git克隆该项目

2. 从数据库中导出sql文件,请尽量导出只有表结构无表数据的sql文件

3. 在项目目录下运行: python build.py sql_dir 其中sql_dir为您的sql文件路径

4. 生成成功的md文件,在项目的md文件夹中,文件名同您的sql文件名

示例

autobuilddocfromdb's Issues

执行出错！

python 2.x & python3.x

可否在README中增加一个Demo

如题，可否增加一个DEMO样式可供便捷查看

md 文件夹不存在时执行出错

建议将 md 文件夹加入 git， 或者将结果目录作为参数传入。

报错

报错如下

$ python build.py ../zerg201806121023.sql
File "build.py", line 19
except IOError, e:
^
SyntaxError: invalid syntax

执行出错了

D:\AutoBuildDocFromDB>python build.py golems.sql
Traceback (most recent call last):
File "build.py", line 38, in
text = markdown_build.buildMarkdown(table_data)
File "D:\AutoBuildDocFromDB\MarkdownBuildClass.py", line 13, in buildMarkdown
text = text + '## ' + table[0][0] + '琛?' + table[0][1] + ')\n'
IndexError: list index out of range

Markdown 表格部分解析器解析错误

建议使用|:---:|:---:|:---:| 替换 |:--:|:--:|:--:|，即增加一个短横。

需要在python2.7的环境下运行

多谢楼主

字段类型没解析出来

sql 文件如下

/*
Navicat MySQL Data Transfer

Source Server         : 120.25.106.228_3306
Source Server Version : 50616
Source Host           : 120.25.106.228:3306
Source Database       : ggly-province-v5

Target Server Type    : MYSQL
Target Server Version : 50616
File Encoding         : 65001

Date: 2017-08-03 08:44:11
*/

SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for `t_1`
-- ----------------------------
DROP TABLE IF EXISTS `t_1`;
CREATE TABLE `t_1` (
`id`  int(11) NOT NULL ,
`code`  varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL ,
`playurl`  varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL ,
PRIMARY KEY (`id`)
)
ENGINE=InnoDB
DEFAULT CHARACTER SET=utf8 COLLATE=utf8_general_ci;

手动把parserColumn中的column_type = tmp_list[1]改成column_type = tmp_list[2]即可