# Smart Query

**Repository Path**: wanfangqing/smart-query

## Basic Information

- **Project Name**: Smart Query
- **Description**: 数据库客户端工具，类似Navicat，功能比较简单。支持AI自然语言查询，降低写SQL的难度。

目前功能尚在完善中，欢迎大家提供宝贵意见
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-29
- **Last Updated**: 2026-02-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Smart Query

#### 介绍

这是一款类似Navicat的客户端工具。

支持数据库连接管理，SQL查询。目标是支持 MySQL、PostgreSQL、MongoDB、SQLite、Redis、ES等多种数据库类型。

同时接入了AI大模型，可以实现用户自然语言检索数据，向用户展示数据. 数据展示方式支持图、表等形式。

#### 软件架构
前后端分离：

后端采用Java技术栈：

前端技术栈：

- 前端框架： React、TypeScript、Vite
- UI组件： shadcn/ui 、Tailwind CSS
- 代码编辑器： Monaco Editor
- 图表库：Recharts
- SQL格式化：sql-formatter


#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1. 创建数据库，执行init_sql中的脚本
2. 后端修改配置文件：配置千问大模型密钥和模型
3. 启动后端服务
4. 前端服务：npm install 安装依赖
5. 启动前端服务 npm run dev

6. 新建数据库连接
7. 连接数据库
8. 进入AI智能问数：选择数据库 + 输入想要查询的自然语言


目前仅仅测试了基础的查询功能，其它功能未测试，可能存在很多漏洞，请提issue

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)