# db2markdown

**Repository Path**: fogray/db2markdown

## Basic Information

- **Project Name**: db2markdown
- **Description**: 导出指定数据库表结构到markdown
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-27
- **Last Updated**: 2021-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# db2markdown

#### 介绍
导出指定数据库表结构到markdown

#### 安装教程

1.  克隆代码到本地
2.  `CGO_ENABLE=0 go build`编译

#### 使用说明
```
./db2markdown -type mysql -h 192.168.10.101 -P 3306 -d db1 -u root -p <password> -o <markdownFile>
```
参数说明：
1. -type：数据库类型，当前仅支持mysql；
2. -h：数据库地址，默认127.0.0.1；
3. -P：数据库端口，默认3306；
4. -d：要操作的数据库名；
5. -u：数据库连接用户，默认root；
6. -p：连接用户密码；
7. -o：导出的markdown文件路径；

#### 导出样例

![image](./exportExample.png)