ChatSQL 项目使用教程

ChatSQL 项目使用教程

ChatSQL项目地址:https://gitcode.com/gh_mirrors/ch/ChatSQL

1. 项目的目录结构及介绍

ChatSQL 项目的目录结构如下：

ChatSQL/
├── config/
│   └── config.data
├── images/
├── src/
│   ├── local_database.py
│   ├── main_gui.py
│   └── main_gui_moss.py
├── .gitignore
├── Dockerfile
├── Makefile
├── README.md
├── conf.json
├── info.json
└── requirements.txt

目录介绍

• config/: 包含配置数据文件。
• images/: 存放项目相关的图片资源。
• src/: 项目的主要源代码目录，包含数据库操作、GUI 启动等脚本。
• .gitignore: Git 忽略文件列表。
• Dockerfile: Docker 容器配置文件。
• Makefile: 用于自动化构建和部署的 Makefile。
• README.md: 项目说明文档。
• conf.json: 项目配置文件。
• info.json: 数据库信息配置文件。
• requirements.txt: 项目依赖包列表。

2. 项目的启动文件介绍

项目的主要启动文件位于 src/ 目录下：

• local_database.py: 用于生成本地数据库并插入数据。
• main_gui.py: 基于 GLM 生成 SQL 的主 GUI 启动文件。
• main_gui_moss.py: 基于 MOSS 生成 SQL 的主 GUI 启动文件。

启动步骤

1. 激活虚拟环境：

   conda activate chatsql
   

2. 运行本地数据库生成脚本：

   python src/local_database.py
   

3. 启动 GUI：

   python src/main_gui.py  # 基于 GLM
   python src/main_gui_moss.py  # 基于 MOSS
   

3. 项目的配置文件介绍

conf.json

conf.json 文件包含项目的全局配置信息，如数据库连接参数、日志路径等。

info.json

info.json 文件包含数据库的详细信息，如表结构、字段类型等。随着数据库复杂度的增加，需要提供更详细的信息。

配置示例

{
    "database": {
        "host": "localhost",
        "user": "root",
        "password": "password",
        "name": "chatsql_db"
    },
    "logging": {
        "path": "logs/"
    }
}

以上是 ChatSQL 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

ChatSQL项目地址:https://gitcode.com/gh_mirrors/ch/ChatSQL