SQLBot Documentation

基于大模型和 RAG 的智能问数系统，对话式数据分析神器。Text-to-SQL Generation via LLMs using RAG.

6,556 stars JavaScript JavaScript 1 file · ~2,373 tokens #chatbi#deepseek#llm#nl2sql#rag#sqlbot#text-to-sql#text2sql
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy SQLBot on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name sqlbot --restart always registry.cn-qingdao.aliyuncs.com/dataease/sqlbot:SQLBOT_TAG
Configured Services & Ports
⚙️ sqlbot
image: registry.cn-qingdao.aliyuncs.com/dataease/sqlbot:SQLBOT_TAG
🔌 Ports: ${SQLBOT_WEB_PORT}:8000, ${SQLBOT_MCP_PORT}:8001
docker-compose.yml
yaml (docker-compose.yml) 
services:
  sqlbot:
    image: registry.cn-qingdao.aliyuncs.com/dataease/sqlbot:SQLBOT_TAG
    container_name: sqlbot
    restart: always
    privileged: true
    networks:
      - sqlbot-network
    ports:
      - ${SQLBOT_WEB_PORT}:8000
      - ${SQLBOT_MCP_PORT}:8001
    env_file:
      - conf/sqlbot.conf
    volumes:
      - ./data/sqlbot/excel:/opt/sqlbot/data/excel
      - ./data/sqlbot/file:/opt/sqlbot/data/file
      - ./data/sqlbot/images:/opt/sqlbot/images
      - ./data/sqlbot/logs:/opt/sqlbot/app/logs
      - ./data/postgresql:/var/lib/postgresql/data

networks:
  sqlbot-network:

1. Project Overview & Quickstart (dataease/SQLBot)

File: README.md

基于大模型和 RAG 的智能问数系统

SQLBot 是一款基于大语言模型和 RAG 的智能问数系统，由 DataEase 开源项目组匠心出品。借助 SQLBot，用户可以实现对话式数据分析（ChatBI），快速提炼获取所需的数据信息及可视化图表，并且支持进一步开展智能分析。

工作原理

核心优势

  • 开箱即用：仅需简单配置大模型与数据源，无需复杂开发，即可快速开启智能问数；依托大模型自然语言理解与 SQL 生成能力，结合 RAG 技术，实现高质量 Text-to-SQL 转换。
  • 安全可控：提供工作空间级资源隔离机制，构建清晰数据边界，保障数据访问安全；支持细粒度数据权限配置，强化权限管控能力，确保使用过程合规可控。
  • 易于集成：支持多种集成方式，提供 Web 嵌入、弹窗嵌入、MCP 调用等能力；能够快速嵌入到 n8n、Dify、MaxKB、DataEase 等应用，让各类应用快速拥有智能问数能力。
  • 越问越准：支持自定义提示词、术语库配置，可维护 SQL 示例校准逻辑，精准匹配业务场景；高效运营，基于用户交互数据持续迭代优化，问数效果随使用逐步提升，越问越准。

支持的大模型服务商

服务商 API 兼容
阿里云百炼 OpenAI 兼容
千帆大模型 OpenAI 兼容
DeepSeek OpenAI 兼容
腾讯混元 OpenAI 兼容
讯飞星火 OpenAI 兼容
Gemini OpenAI 兼容
OpenAI 原生
Kimi OpenAI 兼容
腾讯云 OpenAI 兼容
火山引擎 OpenAI 兼容
MiniMax OpenAI 兼容
通用 OpenAI 兼容 自定义

快速开始

安装部署

准备一台 Linux 服务器，安装好 Docker，执行以下一键安装脚本：

bash
docker run -d \
  --name sqlbot \
  --restart unless-stopped \
  -p 8000:8000 \
  -p 8001:8001 \
  -v ./data/sqlbot/excel:/opt/sqlbot/data/excel \
  -v ./data/sqlbot/file:/opt/sqlbot/data/file \
  -v ./data/sqlbot/images:/opt/sqlbot/images \
  -v ./data/sqlbot/logs:/opt/sqlbot/app/logs \
  -v ./data/postgresql:/var/lib/postgresql/data \
  --privileged=true \
  dataease/sqlbot

你也可以通过 1Panel 应用商店 快速部署 SQLBot。

如果是内网环境，你可以通过 离线安装包方式 部署 SQLBot。

访问方式

  • 在浏览器中打开: http://<你的服务器IP>:8000/
  • 用户名: admin
  • 密码: SQLBot@123456

联系我们

如你有更多问题，可以加入我们的技术交流群与我们交流。

UI 展示

Star History

飞致云旗下的其他明星项目

  • DataEase - 人人可用的开源 BI 工具
  • 1Panel - 现代化、开源的 Linux 服务器运维管理面板
  • MaxKB - 强大易用的企业级智能体平台
  • JumpServer - 广受欢迎的开源堡垒机
  • Cordys CRM - 新一代的开源 AI CRM 系统
  • Halo - 强大易用的开源建站工具
  • MeterSphere - 新一代的开源持续测试工具

License

本仓库遵循 FIT2CLOUD Open Source License 开源协议，该许可证本质上是 GPLv3，但有一些额外的限制。

你可以基于 SQLBot 的源代码进行二次开发，但是需要遵守以下规定：

  • 不能替换和修改 SQLBot 的 Logo 和版权信息；
  • 二次开发后的衍生作品必须遵守 GPL V3 的开源义务。

File: docs/README.en.md

Intelligent Questioning System Based on Large Models and RAG

SQLBot is an intelligent data query system based on large language models and RAG, meticulously crafted by the DataEase open-source project team. With SQLBot, users can perform conversational data analysis (ChatBI), quickly extracting the necessary data information and visualizations, and supporting further intelligent analysis.

How It Works

Key Features

  • Out-of-the-Box Functionality: Simply configure the large model and data source; no complex development is required to quickly enable intelligent data collection. Leveraging the large model's natural language understanding and SQL generation capabilities, combined with RAG technology, it achieves high-quality Text-to-SQL conversion.
  • Secure and Controllable: Provides a workspace-level resource isolation mechanism, building clear data boundaries and ensuring data access security. Supports fine-grained data permission configuration, strengthening permission control capabilities and ensuring compliance and controllability during use.
  • Easy Integration: Supports multiple integration methods, providing capabilities such as web embedding, pop-up embedding, and MCP invocation. It can be quickly embedded into applications such as n8n, Dify, MaxKB, and DataEase, allowing various applications to quickly acquire intelligent data collection capabilities.
  • Increasingly Accurate with Use: Supports customizable prompts and terminology library configurations, maintainable SQL example calibration logic, and accurate matching of business scenarios. Efficient operation, based on continuous iteration and optimization using user interaction data, the data collection effect gradually improves with use, becoming more accurate with each use.

Supported LLM Providers

Provider API Compatibility
Alibaba Cloud Bailian OpenAI Compatible
Qianfan Model OpenAI Compatible
DeepSeek OpenAI Compatible
Tencent Hunyuan OpenAI Compatible
iFlytek Spark OpenAI Compatible
Gemini OpenAI Compatible
OpenAI Native
Kimi OpenAI Compatible
Tencent Cloud OpenAI Compatible
Volcano Engine OpenAI Compatible
MiniMax OpenAI Compatible
Generic OpenAI Compatible Custom

Quick Start

Installation and Deployment

Prepare a Linux server, install Docker, and execute the following one-click installation script:

bash
docker run -d \
  --name sqlbot \
  --restart unless-stopped \
  -p 8000:8000 \
  -p 8001:8001 \
  -v ./data/sqlbot/excel:/opt/sqlbot/data/excel \
  -v ./data/sqlbot/file:/opt/sqlbot/data/file \
  -v ./data/sqlbot/images:/opt/sqlbot/images \
  -v ./data/sqlbot/logs:/opt/sqlbot/app/logs \
  -v ./data/postgresql:/var/lib/postgresql/data \
  --privileged=true \
  dataease/sqlbot

You can also quickly deploy SQLBot through the 1Panel app store.

If you are in an intranet environment, you can deploy SQLBot via the offline installation package.

Access methods

  • Open in your browser: http://:8000/
  • Username: admin
  • Password: SQLBot@123456

UI Display

Star History

Other star projects under FIT2CLOUD

  • DataEase - Open source BI tools
  • 1Panel - A modern, open-source Linux server operation and maintenance management panel
  • MaxKB - Powerful and easy-to-use enterprise-grade intelligent agent platform
  • JumpServer - Popular open source bastion hosts
  • Cordys CRM - A new generation of open-source AI CRM systems
  • Halo - Powerful and easy-to-use open-source website building tools
  • MeterSphere - Next-generation open-source continuous testing tools

License

This repository is licensed under the FIT2CLOUD Open Source License, which is essentially GPLv3 but with some additional restrictions.

You may conduct secondary development based on the SQLBot source code, but you must adhere to the following:

  • You cannot replace or modify the SQLBot logo and copyright information;

  • Derivative works resulting from secondary development must comply with the open-source obligations of GPL v3.

For commercial licensing, please contact [email protected].

File: frontend/public/tinymce/langs/README.md

This is where language files should be placed.

Please DO NOT translate these directly, use this service instead: https://crowdin.com/project/tinymce

2. Official Technical Reference & Guides (dataease/SQLBot-docs)

File: README.md

本仓库保存了 SQLBot 项目 的 官方文档，该文档使用 MkDocs 文档框架下的 Material for MkDocs 主题进行构建。

本地开发

克隆本仓库

bash
git clone [email protected]:dataease/SQLBot-Docs.git

安装依赖

bash
cd SQLBot-Docs
pip install -r requirements/requirements.txt

修改文档内容

本文档的文档结构定义在 mkdocs.yml 文件中，文档的具体内容均在 docs 目录中。
文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 mkdocs.yml 文件中的 nav 部分增加对应章节导航。

本地调试文档

bash
mkdocs serve

执行上述命令后，可通过 http://127.0.0.1:8000 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。

构建文档

bash
mkdocs build

执行上述命令后，会在 site 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。

帮助完善文档

Fork 文档仓库

点击仓库右上角的 fork 按钮，复制本仓库到自己的 github 账号。

克隆 fork 后的仓库

bash
git clone https://github.com/your-github-account/SQLBot-Docs.git

本地修改并调试

Push 修改内容到 GitHub 仓库

提交 Pull Request 到本仓库

File: docs/index.md

产品介绍

!!! Tip ""

text
SQLBot 是一款基于大语言模型（Large Language Model，LLM）和 RAG（Retrieval Augmented Generation，检索增强生成）的智能问数系统。借助 SQLBot，用户可以实现数据的即问即答，快速提炼获取所需的数据信息及可视化图表，并且支持进一步开展智能分析。

SQLBot 由飞致云的 [DataEase](https://dataease.cn/) 开源团队出品。

1 工作原理

2 产品优势

!!! Tip ""

text
- **开箱即用**      
  仅需简单配置大模型与数据源，无需复杂开发，即可快速开启智能问数；依托大模型自然语言理解与 SQL 生成能力，结合 RAG 技术，实现高质量 Text-to-SQL 转换。

- **安全可控**      
  提供工作空间级资源隔离机制，构建清晰数据边界，保障数据访问安全；支持细粒度数据权限配置，强化权限管控能力，确保使用过程合规可控。

- **易于集成**    
  支持多种集成方式，提供 Web 嵌入、弹窗嵌入、MCP 调用等能力；能够快速嵌入到 n8n、Dify、MaxKB、DataEase 等应用，让各类应用快速拥有智能问数能力。

- **越问越准**  
  支持自定义提示词、术语库配置，可维护 SQL 示例校准逻辑，精准匹配业务场景；高效运营，基于用户交互数据持续迭代优化，问数效果随使用逐步提升，越问越准。

3 界面展示

4 主要功能

!!! Tip ""

text
- 提问分析：用户聊天对话方式提问，大模型解析问题意图，结合所选数据源生成图表与分析。
- 深度探索：在获得基础图表结果后，进一步进行分析、解释、验证和预测，支持更强的业务决策支持。
- 数据管理：支持用户配置、管理多种类型的数据源和数据表，支持按需配置和管理。
- 看板搭建：将多个问数对话生成的图表统一布局，构建成适用于汇报、监控或展示的仪表板。

5 了解更多

!!! Tip ""

text
- [了解飞致云](https://www.fit2cloud.com/) 
- [飞致云开源社区论坛](https://bbs.fit2cloud.com/)

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#chatbi Browse chatbi catalog → #deepseek Browse deepseek catalog → #llm Browse llm catalog → #nl2sql Browse nl2sql catalog → #rag Browse rag catalog → #sqlbot Browse sqlbot catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →