.. image:: https://readthedocs.org/projects/django-sql-explorer/badge/?version=latest :target: https://django-sql-explorer.readthedocs.io/en/latest/?badge=latest :alt: 文档状态

.. image:: http://img.shields.io/pypi/v/django-sql-explorer.svg?style=flat-square :target: https://pypi.python.org/pypi/django-sql-explorer/ :alt: 最新版本

.. image:: http://img.shields.io/pypi/dm/django-sql-explorer.svg?style=flat-square :target: https://pypi.python.org/pypi/django-sql-explorer/ :alt: 下载量

.. image:: http://img.shields.io/pypi/l/django-sql-explorer.svg?style=flat-square :target: https://pypi.python.org/pypi/django-sql-explorer/ :alt: 许可证

SQL Explorer

• 官方网站 <https://www.sqlexplorer.io/>_
• 在线演示 <https://demo.sqlexplorer.io/>_
• 文档 <https://django-sql-explorer.readthedocs.io/en/latest/>_

视频导览

.. |inline-image| image:: https://sql-explorer.s3.amazonaws.com/video-thumbnail.png :target: https://sql-explorer.s3.amazonaws.com/Sql+Explorer+5.mp4 :height: 10em

|inline-image|

快速入门

项目中包含一个完整的测试工程，供您快速体验。

1. 运行 docker compose up
2. 打开浏览器访问 127.0.0.1:8000/explorer/
3. 使用 admin/admin 登录
4. 开始探索吧！

同时会启动一个带有热重载功能的 Vite 开发服务器，方便前端代码的实时更新。

关于

SQL Explorer 致力于让数据在人与人之间的流动更加迅速、简单且无歧义。它是一个基于 Django 的应用，既可以集成到现有的 Django 站点中，也可以作为独立的商业智能工具使用。它可以轻松连接到任何 Django 支持的 SQL 数据库（详见：Django 官方文档 <https://docs.djangoproject.com/en/5.0/ref/databases/>_），以及用户上传的 CSV、JSON 或 SQLite 数据库。

通过简洁易用的 SQL 编辑器，您可以快速编写和分享 SQL 查询，在浏览器中查看结果，从而保持信息的顺畅流通。只需添加 OpenAI（或其他提供商）的 API 密钥，即可获得由大语言模型驱动的 SQL 助手，帮助您编写和调试查询。该助手会自动将相关上下文和数据库模式整合到底层的大模型提示词中。

SQL Explorer 注重简洁性、直观易用、低调不打扰、稳定性以及“最小惊讶原则”。该项目采用 MIT 许可证开源，欢迎贡献代码。

主要特性包括：

• 支持多连接，既可由管理员配置，也可由用户自行提供。
• 用户可以上传 JSON 或 CSV 文件并立即进行查询。
• AI 驱动的 SQL 助手。
• 快速访问数据库模式信息，简化查询操作（包括自动补全功能）。
• 可按计划定期截取查询快照，记录数据变化。
• 查询历史与日志记录。
• 浏览器内快速生成统计图表、透视表和散点图，无需再转到 Excel 进行简单分析。
• 参数化查询，为不懂 SQL 的用户提供友好的交互界面。
• 提供游乐场区域，方便快速执行临时查询。
• 将查询结果通过邮件发送。
• 保存的查询可根据需要暴露为简易的 JSON API。
• ……以及其他更多功能！

截图

编写查询并查看模式辅助

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-query-with-schema.png

---

使用 SQL AI 助手

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-assistant.png

---

查看所有查询

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-query-list.png

---

查询结果及统计摘要

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-query-results.png

---

浏览器内透视

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-pivot.png

---

查看日志

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-querylogs.png

SQL Explorer 快速上手指南

SQL Explorer 是一款基于 Django 的开源工具，旨在让数据流动更快速、简单。它支持连接多种 SQL 数据库，允许用户上传 CSV/JSON 文件进行查询，并提供 AI 辅助编写 SQL、浏览器内数据透视表及可视化统计等功能。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• 核心依赖：
  • Docker 和 Docker Compose（推荐用于快速启动）
  • 或者：Python 3.8+ 及 pip（如需手动集成到现有 Django 项目）
• 网络要求：能够访问 PyPI 源下载依赖包（国内用户可配置清华或阿里镜像加速）

安装步骤

最快捷的方式是使用官方提供的完整测试项目进行体验，无需手动配置 Django 环境。

1. 克隆项目代码

   git clone https://github.com/explore-data/django-sql-explorer.git
   cd django-sql-explorer
   

2. 启动服务 使用 Docker Compose 一键启动后端服务及前端热重载开发服务器：

   docker compose up
   

   提示：国内用户若拉取镜像缓慢，可配置 Docker 国内镜像加速器。

3. 访问应用 服务启动完成后，在浏览器中打开： http://127.0.0.1:8000/explorer/

4. 登录系统 使用默认管理员账号登录：

   • 用户名：admin
   • 密码：admin

基本使用

登录成功后，您可以立即开始探索数据：

1. 编写与运行查询

   • 点击 "New Query" 创建新查询。
   • 在编辑器中输入 SQL 语句（例如：SELECT * FROM auth_user LIMIT 10;）。
   • 利用右侧的 Schema Helper 查看表结构并自动补全字段。
   • 点击 "Run" 执行，结果将直接在浏览器中以表格形式展示。

2. 使用 AI 助手 (可选)

   • 在设置中配置 OpenAI API Key。
   • 在查询编辑区调用 AI 助手，它会自动读取当前数据库 Schema 上下文，帮助您生成或调试复杂的 SQL 语句。

3. 数据分析与可视化

   • 查询结果页面提供内置统计信息。
   • 点击 "Pivot" 标签页，无需导出到 Excel 即可在浏览器内直接生成数据透视表。
   • 支持生成简单的散点图进行趋势分析。

4. 上传外部数据

   • 您可以直接上传本地的 .csv、.json 或 .sqlite 文件，系统将自动将其转换为可查询的临时表，方便进行即席分析。

5. 保存与分享

   • 保存查询后，可生成专属链接分享给团队成员。
   • 支持将保存的查询暴露为简易的 JSON API 端点，供其他系统调用。