# 智绘AI-SQL

**Repository Path**: tyerp/ai-sql

## Basic Information

- **Project Name**: 智绘AI-SQL
- **Description**: 智绘SQL - 用AI将自然语言转换为SQL查询，自动生成专业数据可视化图表
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-12-14
- **Last Updated**: 2026-01-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Chat2Chart - AI 智能数据库工具

一个功能强大的 AI 驱动的数据库管理、查询和可视化工具，帮助用户更高效地与数据库交互并生成数据图表。

## 🎯 核心功能

- **AI 对话查询**：通过自然语言描述生成 SQL 查询语句
- **AI 表结构生成**：根据需求描述自动生成表结构设计
- **数据可视化**：自动将查询结果转换为直观的图表
- **历史查询管理**：记录和管理历史查询记录
- **多数据库支持**：兼容 MySQL、PostgreSQL、SQL Server 和 SQLite
- **响应式设计**：适配桌面端和移动端设备
- **主题切换**：支持亮色和暗色主题
- **数据导出**：支持导出为 Excel 和 Markdown 格式
- **智能推荐**：基于表结构推荐常用查询
- **SQL 格式化**：自动格式化 SQL 语句，提高可读性

## 🛠️ 技术栈

- **前端框架**：Next.js 14
- **UI 组件**：原生 Tailwind CSS
- **状态管理**：React Context API
- **数据交互**：RESTful API
- **数据库支持**：MySQL、PostgreSQL、SQL Server、SQLite
- **图表库**：ECharts
- **AI 集成**：ARK API
- **其他工具**：SQL Formatter、React Markdown、XLSX

## 📦 安装与配置

### 环境要求

- Node.js 18.0+
- npm 9.0+

### 安装步骤

1. **克隆项目**
   ```bash
   git clone <repository-url>
   cd ai-sql
   ```

2. **安装依赖**
   ```bash
   npm install
   ```

3. **配置环境变量**
   创建 `.env.local` 文件并添加以下配置：
   ```
   # ARK API Key (必填)
   ARK_API_KEY=your_ark_api_key

   # 其他配置 (可选)
   NEXT_PUBLIC_APP_NAME="AI SQL"
   ```

4. **启动开发服务器**
   ```bash
   npm run dev
   ```

5. **构建生产版本**
   ```bash
   npm run build
   npm start
   ```

## 🎯 适用场景

### 数据分析师
- 通过自然语言快速生成复杂查询
- 一键转换查询结果为可视化图表
- 专注于数据洞察而非SQL语法

### 报表开发者
- 用自然语言描述报表需求
- 自动生成SQL并转换为专业图表
- 大幅提升报表开发效率

### SQL初学者
- 通过自然语言学习SQL语法
- 观察AI生成的查询并查看结果
- 直观了解数据可视化过程

### 产品经理
- 无需SQL知识，快速验证产品假设
- 自动生成数据图表展示产品表现
- 快速获取数据支持的决策依据

### 后端开发者
- 用自然语言快速生成测试SQL
- 验证数据库结构和性能
- 自动生成数据可视化图表展示结果

### DevOps工程师
- 用自然语言快速编写监控查询
- 自动生成性能趋势图表
- 高效分析系统状态和性能问题

## 🚀 快速开始

1. **配置数据库连接**
   - 点击左侧菜单中的「设置」
   - 添加数据库连接配置（支持 MySQL、PostgreSQL、SQL Server、SQLite）
   - 测试连接并保存配置

2. **使用 AI 对话**
   - 点击左侧菜单中的「对话」
   - 以自然语言描述您的查询需求
   - 系统会自动生成 SQL 语句并执行
   - 查看执行结果和自动生成的图表

3. **生成表结构**
   - 点击左侧菜单中的「AI 建表」
   - 描述您需要的表结构和业务需求
   - 系统会自动生成表结构设计和建表 SQL

4. **查看历史查询**
   - 点击左侧菜单中的「历史」
   - 浏览和管理历史查询记录
   - 可以重新执行或编辑历史查询

5. **查看数据库表**
   - 点击左侧菜单中的「表格」
   - 查看数据库中的表结构
   - 浏览表数据和字段信息

## 📱 移动端适配

项目采用响应式设计，在移动端设备上有以下优化：

- 侧边栏自动折叠为汉堡菜单
- 表单元素垂直堆叠以适应小屏幕
- 表格在移动端自动隐藏次要列
- 按钮和输入框尺寸适配触摸操作
- 图表自适应调整大小以适应屏幕

## 🔧 配置说明

### 数据库配置

在「设置」页面中，您可以添加多个数据库配置：

- **MySQL**：需要配置主机、端口、数据库名、用户名和密码
- **PostgreSQL**：需要配置主机、端口、数据库名、用户名和密码
- **SQL Server**：需要配置主机、端口、数据库名、用户名和密码
- **SQLite**：只需要配置数据库文件路径

### API Key 配置

在「设置」页面中，您需要配置 ARK API Key 以使用 AI 功能：

- 从 ARK 平台获取 API Key
- 在设置页面中输入并保存
- 保存后即可使用 AI 对话和表结构生成功能

## 🤝 贡献指南

1. **Fork 项目**
2. **创建特性分支** (`git checkout -b feature/amazing-feature`)
3. **提交更改** (`git commit -m 'Add some amazing feature'`)
4. **推送到分支** (`git push origin feature/amazing-feature`)
5. **打开 Pull Request**

## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情

## 📞 联系方式

如有问题或建议，请通过以下方式联系：

- 作者：拓宇
- 邮箱：tydl@163.com

---

**享受智能数据库管理的便捷体验！** 🎉