# db_dto_helper

**Repository Path**: haven5/db_dto_helper

## Basic Information

- **Project Name**: db_dto_helper
- **Description**: 数据库开发工具类
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-16
- **Last Updated**: 2025-09-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 数据库文档生成工具

这是一个基于 Web 的数据库文档生成工具，支持连接多种数据库并生成相应的数据表结构文档。适用于需要频繁生成或更新数据库文档的开发人员和数据库管理员。

## 功能特性

- 支持多种数据库（MySQL、PostgreSQL、SQL Server、SQLite）
- 数据库连接管理
- 数据表结构查看
- 字段描述维护
- 数据集管理
- 集成 AI 聊天功能（实验性）

## 支持的数据库

- MySQL
- PostgreSQL
- SQL Server
- SQLite

## 安装指南

1. 克隆仓库:
```bash
git clone https://gitee.com/haven5/db_dto_helper.git
```

2. 安装依赖:
```bash
pip install -i  https://mirrors.aliyun.com/pypi/simple -r requirements.txt
```

3. 配置数据库连接信息（在应用中设置）
 
   1 创建.env文件 写入api_key="换成自己的" 如 sk-1123456666
   
   2 使用脚本创建表 脚本在 connect.py文件的注释中
   
   3 数据库文件也需要自己手动创建  data/DbDtoHelper.db


4. 运行应用:
```bash
python app.py
```

5. 访问 http://localhost:5000 在浏览器中使用

## 使用说明

1. 添加数据库连接
2. 选择数据库和数据表
3. 查看和编辑字段描述
4. 生成文档
5. (可选) 使用 AI 功能进行数据库相关的问答

## 目录结构

```
├── app.py                  # 应用入口文件
├── requirements.txt        # 依赖包列表
├── data/        # 依赖包列表
│   └── DbDtoHelper.db         #数据库文件
├── .env        # 环境变了配置大模型KEY  api_key="sk-1123456666"
├── db_dto_helper/
│   ├── __init__.py         # 应用工厂
│   ├── models/             # 数据模型
│   │   └── DbConnEntity.py
│   ├── static/             # 静态资源
│   │   ├── css/
│   │   └── js/
│   ├── templates/          # 前端模板
│   │   ├── connect.html
│   │   ├── dataset.html
│   │   ├── dto.html
│   │   └── index.html
│   ├── utils/              # 数据库工具类
│   │   ├── MssqlHelper.py
│   │   ├── MysqlHelper.py
│   │   ├── PgsqlHelper.py
│   │   └── SQLiteHelper.py
│   └── views/              # 路由和视图
│       ├── aiservice.py
│       ├── connect.py
│       ├── dataset.py
│       ├── dto_service.py
│       └── home.py
```

## 贡献指南

欢迎贡献代码！请遵循以下步骤：

1. Fork 仓库
2. 创建新分支
3. 提交更改
4. 创建 Pull Request

## 许可证

本项目使用 MIT 许可证 - 详见 LICENSE 文件