# py数据库导出

**Repository Path**: DanRanhan/py-database-export

## Basic Information

- **Project Name**: py数据库导出
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-06
- **Last Updated**: 2025-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MySQL数据库结构导出工具

## 项目介绍
这是一个开源的MySQL数据库表结构导出工具，支持将数据库表结构导出为Markdown或Word格式。支持图形界面和命令行两种使用方式。

项目地址：[https://gitee.com/DanRanhan/py-database-export](https://gitee.com/DanRanhan/py-database-export)

## 功能特点
- 支持导出为Markdown格式（.md文件）
- 支持导出为Word格式（.docx文件）
- 双模式操作：图形界面或命令行
- 支持自定义导出文件路径
- 显示完整的表结构信息，包括字段名、类型、主键、默认值、描述等
- 支持中文界面和输出
- 支持保存数据库连接配置
## 快速开始

### 方式一：直接运行（Windows）
项目目录下的 `run_me.exe` 是已经打包好的可执行文件，双击即可直接使用，无需安装 Python 环境。

### 方式二：源码运行
1. 克隆项目
```bash
git clone https://gitee.com/DanRanhan/py-database-export.git
cd py-database-export
```

2. 安装依赖
```bash
pip install pymysql python-docx
```

3. 运行程序
```bash
python database.py
```
```


## 使用说明

### 1. 图形界面模式
直接运行程序后，在界面中填写：
- 主机地址（默认：127.0.0.1）
- 端口（默认：3306）
- 用户名
- 密码
- 数据库名称

支持保存常用的数据库连接配置，方便重复使用。

### 2. 命令行模式
```bash
# 基本格式
python database.py --host 主机地址 --port 端口 --user 用户名 --password 密码 --database 数据库名 --format 导出格式 --output 输出文件路径

# 示例
python database.py --host localhost --port 3306 --user root --password 123456 --database testdb --format markdown --output db_doc.md
```

命令行参数说明：
- `--host`：数据库主机地址，默认为 127.0.0.1
- `--port`：数据库端口，默认为 3306
- `--user`：数据库用户名
- `--password`：数据库密码
- `--database`：要导出的数据库名
- `--format`：导出格式，可选 markdown 或 word
- `--output`：输出文件路径，默认为当前目录下的 db_structure.md 或 db_structure.docx

## 打包使用

### 1. 安装打包工具
```bash
pip install pyinstaller
```

### 2. 打包命令
```bash
# 基本打包（生成单文件）
pyinstaller --noconsole --onefile --name db_export_tool database.py
```

打包后的文件位置：
- 可执行文件在 `dist` 目录下
- Windows系统生成 `db_export_tool.exe`
- Linux/Mac系统生成 `db_export_tool`

## 输出示例
### Markdown格式
```markdown
# 数据库表结构

## 表名：`user` (用户信息表)
| 字段名 | 类型    | 主键 | 默认值 | 描述   |
|--------|---------|------|--------|--------|
| id     | int     | 是   | 无     | 用户ID |
```

### Word格式
生成的Word文档包含完整的表格式结构，便于查看和分享。

## 常见问题
1. 导出Word格式失败
   - 解决方案：执行 `pip install python-docx`

2. 连接数据库失败
   - 检查数据库服务是否启动
   - 验证用户名密码是否正确
   - 确认数据库名称是否存在

## 参与贡献

1. Fork 本仓库
2. 新建分支 `git checkout -b feature/your-feature`
3. 提交代码 `git commit -am 'Add your feature'`
4. 推送到分支 `git push origin feature/your-feature`
5. 提交 Pull Request

## 开源协议
MIT License

## 联系方式
如有问题或建议，欢迎在 [Gitee Issues](https://gitee.com/DanRanhan/py-database-export/issues) 中提出。