Skip to content

HOW_TO_START.md

Latest commit

 

History

History
173 lines (132 loc) · 3.49 KB

HOW_TO_START.md

File metadata and controls

173 lines (132 loc) · 3.49 KB
Raw

🚀 如何开始使用

第一步：了解项目

MySQL优化系统是一个基于OpenClaw的数据库优化Agent，能够将自然语言查询转换为高效的MySQL查询语句。

主要功能：

  • 自然语言转SQL
  • 查询优化建议
  • 数据库连接管理
  • 性能分析
  • 查询历史记录

第二步：安装依赖

1. 打开终端/命令行

  • Windows: 按 Win + R，输入 cmd 或 powershell
  • macOS: 打开 终端
  • Linux: 打开 终端

2. 进入项目目录

cd f:\MySQL优化系统

3. 安装Python依赖

cd backend
pip install -r requirements.txt

如果遇到权限问题，使用：

pip install --user -r requirements.txt

第三步：启动后端服务

方式一：使用启动脚本（推荐）

# Windows
start.bat

# PowerShell
.\start.ps1

方式二：手动启动

cd backend
python app.py

成功启动后，您将看到：

INFO:     Started server process [xxxxx]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)

第四步：打开前端界面

1. 找到前端文件

在文件管理器中打开：

f:\MySQL优化系统\frontend\index.html

2. 用浏览器打开

  • 双击 index.html 文件
  • 或者右键选择"打开方式" -> "浏览器"

3. 开始使用

在输入框中输入查询描述，点击"优化查询"按钮。

第五步：体验功能

尝试第一个查询

在输入框中输入：

查询所有用户的订单信息，按订单金额降序排列，只显示前100条记录

点击"优化查询"按钮，查看生成的SQL语句。

尝试其他查询

统计每个类别的产品数量

查找最近30天内有订单的用户

更新所有未付款订单的状态

常见问题

Q1: Python未安装怎么办？

A: 下载并安装Python 3.8+

Q2: pip命令找不到怎么办？

A: 使用以下命令：

python -m pip install -r requirements.txt

Q3: 端口8000被占用怎么办？

A:

  1. 找到占用端口的程序并关闭
  2. 或者修改 backend/app.py 中的端口号：
uvicorn.run(app, host="0.0.0.0", port=8001)  # 改为8001

Q4: 前端页面空白怎么办？

A:

  1. 确保后端服务已启动
  2. 检查浏览器控制台是否有错误
  3. 尝试刷新页面

Q5: 查询优化不工作怎么办？

A:

  1. 检查后端服务是否正常运行
  2. 查看终端是否有错误信息
  3. 系统会自动降级到本地优化逻辑

下一步

1. 配置数据库连接

在"数据库连接"页面添加您的MySQL数据库连接。

2. 导入示例数据

mysql -u root -p mysql_optimizer < init.sql

3. 探索更多功能

  • 查看查询历史
  • 分析SQL性能
  • 优化数据库结构

获取帮助

查看文档

运行测试

python test_api.py

查看API文档

启动后端后，访问：http://localhost:8000/docs

🎉 开始使用

现在您已经了解了如何开始使用MySQL优化系统。

立即开始：

  1. 运行 start.bat 或 .\start.ps1
  2. 打开 frontend/index.html
  3. 输入您的第一个查询
  4. 享受优化带来的性能提升！

祝您使用愉快！ 🚀