Skip to content

YuMichael04/talk_sql

Repository files navigation

TalkSQL - 基于自然语言的数据查询Agent

TalkSQL是一个强大的基于自然语言的数据查询Agent,允许您使用日常语言查询MySQL和PostgreSQL数据库,无需编写复杂的SQL语句。

核心特性

  • 基于自然语言的智能查询:使用日常语言描述您的数据需求,AI自动生成并执行SQL
  • 多数据库支持:同时支持MySQL和PostgreSQL数据库
  • 强大的工具集
    • 获取数据库数据表
    • 获取数据表结构
    • 数据查询执行
    • 尝试完成任务
    • 向用户提问获取更多信息
  • 数据源管理
    • 数据源配置存储在SQLite中
    • 所有操作严格限制在用户配置的数据源内
    • 数据表、数据结构、数据查询都依赖匹配数据源才能执行
  • 双界面支持
    • Web界面:基于Next.js构建的友好网页应用
    • 命令行界面(CLI):支持终端直接使用
  • 安全可靠:严格的安全指南保护数据库信息不泄露
  • 高效执行:自动优化SQL查询,确保高效执行

快速开始

Web界面

npm run dev

然后打开 http://localhost:3000 即可使用Web界面。

命令行界面

npm run cli

支持的数据库

  • MySQL
  • PostgreSQL

主要功能

  1. 自然语言转SQL:输入"查询最近7天的销售数据",AI自动生成并执行相应SQL
  2. 数据库探索:自动发现数据库表结构,无需手动查看文档
  3. 智能交互:当查询条件不明确时,自动向用户提问获取更多信息
  4. 结果可视化:清晰展示查询结果,支持多种数据格式
  5. 数据源管理:通过SQLite存储和管理数据源配置

技术栈

  • Next.js + React
  • TypeScript
  • OpenAI API
  • Knex.js(数据库连接)
  • SQLite(数据源配置存储)

部署

可以使用Vercel或其他Next.js支持的平台进行部署。

npm run build
npm start

许可证

MIT

About

TalkSQL是一个简单的基于自然语言的数据查询Agent

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages