# db2doc

**Repository Path**: system/db2doc

## Basic Information

- **Project Name**: db2doc
- **Description**: 数据库文档导出工具 (DB2Doc)
一个简单易用的数据库文档生成工具，支持多种数据库类型，可快速导出表结构和数据。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-03-31
- **Last Updated**: 2025-07-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 数据库文档导出工具 (DB2Doc)

一个简单易用的数据库文档生成工具，支持多种数据库类型，可快速导出表结构和数据。

## 功能特点

- 支持多种数据库类型：MySQL、SQLite、Oracle、H2等
- 友好的图形界面，操作简单直观
- 多种导出格式：Excel文档、表结构SQL、表结构及数据SQL
- 可编辑表和字段描述信息
- 跨平台支持：Windows、Mac、Linux

## 安装方法

1. 克隆本仓库到本地
```bash
git clone https://github.com/yourusername/db2doc.git
cd db2doc
```

2. 安装依赖
```bash
pip install -r requirements.txt
```

## 使用方法

运行主程序：
```bash
python src/main.py
```

### 使用步骤

1. **选择数据库类型并连接**
   - 从下拉菜单选择数据库类型
   - 填写连接信息（主机、端口、用户名、密码等）
   - 点击"测试连接"确认连接正常
   - 点击"连接"进入下一步

2. **筛选数据库表**
   - 在列表中选择需要导出的表（可多选或全选）
   - 可以点击表名进入表结构详情页面
   - 可以在此页面添加表的描述信息
   - 选择完成后点击"下一步"

3. **查看和编辑表结构**
   - 查看选定表的字段结构
   - 编辑字段的描述信息
   - 完成后点击"下一步"

4. **导出文档**
   - 选择导出格式（Excel、表结构SQL、表结构及数据SQL）
   - 选择保存位置
   - 点击"导出"完成操作

## 导出格式说明

- **Excel文档**：包含两个工作表，一个是表结构信息，另一个是表的描述信息
- **表结构SQL**：生成创建表的SQL语句，包含表的概要信息和详细结构
- **表结构及数据SQL**：在表结构SQL的基础上，添加数据的INSERT语句

## 构建安装程序

本项目提供了两个构建脚本，用于生成不同平台的安装程序。

### 基本构建（当前平台）

使用 `build.py` 脚本可以在当前平台构建安装程序：

```bash
python build.py
```

这将根据当前运行的操作系统生成对应的安装程序（Windows的.exe、macOS的.dmg或Linux的.deb/.rpm）。

### 跨平台构建

使用 `multi_platform_build.py` 脚本可以构建多个平台的安装程序：

```bash
# 构建所有平台
python multi_platform_build.py

# 只构建特定平台
python multi_platform_build.py --platforms windows macos

# 指定版本号
python multi_platform_build.py --version 1.1.0

# 指定输出目录
python multi_platform_build.py --output-dir ./releases
```

跨平台构建需要Docker环境。如果检测到Docker可用，脚本会自动使用Docker容器进行构建；否则，只会构建当前平台的安装程序。

构建完成后，安装程序会保存在 `output` 目录中，按平台分类。

## 许可证

MIT

## 联系方式

如有问题或建议，请提交Issue或Pull Request。