# nl2sql-demo

**Repository Path**: goodboy119/nl2sql-demo

## Basic Information

- **Project Name**: nl2sql-demo
- **Description**: 自然语言转SQL查询系统，支持通过自然语言生成对应的SQL查询语句。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-02-19
- **Last Updated**: 2025-03-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NL2SQL Demo

自然语言转SQL查询系统，支持通过自然语言生成对应的SQL查询语句。

## 项目结构

```
├── nl2sql-ui/          # 前端项目 (Vue3)
├── src/                # 后端源码
│   ├── main/          # 主要代码
│   └── test/          # 测试代码
├── Schema.json         # 开发环境数据库结构
├── SchemaProd.json    # 生产环境数据库结构
└── pom.xml            # Maven 项目配置
```

## 技术栈

### 后端
- Java
- Spring Boot
- MyBatis
- MySQL

### 前端
- Vue 3
- Element Plus
- Tailwind CSS
- Axios
- Vite

## 快速开始

### 后端服务
1. 确保已安装 JDK 17 或以上版本
2. 确保已安装 Maven
3. 配置数据库连接
4. 运行服务
```bash
mvn spring-boot:run
```

### 前端服务
前端项目位于 `nl2sql-ui` 目录，详细说明请参考该目录下的 README.md。

## API 文档

### 自然语言转SQL查询
- 接口：`POST /api/nl2sql/query`
- 请求体：
```json
{
    "query": "查询所有水位站"
}
```
- 响应：
```json
{
    "code": 0,
    "data": {
        "sql": "SELECT * FROM station_info",
        "results": [...]
    }
}
```

## 环境要求
- JDK 17+
- Maven 3.6+
- Node.js 16+
- MySQL 8.0+

## 部署说明
1. 后端部署
   - 使用 `mvn package` 打包
   - 生成的 jar 文件位于 `target` 目录
   - 使用 `java -jar` 命令运行

2. 前端部署
   - 在 `nl2sql-ui` 目录下执行 `npm run build`
   - 将 `dist` 目录下的文件部署到 Web 服务器