Django SQL Explorer 安装与配置指南

Django SQL Explorer 安装与配置指南

django-sql-explorer Easily share data across your company via SQL queries. From Grove Collab. 项目地址: https://gitcode.com/gh_mirrors/dja/django-sql-explorer

项目简介

Django SQL Explorer 是一个强大的Django应用程序，它允许开发者和数据分析师直接在Web界面上编写和执行SQL查询，无需离开Django环境。该工具特别适合需要快速访问数据库进行数据探索和分析的场景。

环境要求

在开始安装前，请确保您的系统满足以下基本要求：

• Python 3.10或更高版本
• Django 3.2或更高版本

安装步骤

1. 创建Django项目

如果您还没有Django项目，可以通过以下命令创建一个：

pip install django
django-admin startproject project

2. 安装Django SQL Explorer

使用pip从PyPI安装Django SQL Explorer：

pip install django-sql-explorer

3. 配置Django项目

添加应用到INSTALLED_APPS

在项目的settings.py文件中，将'explorer'添加到INSTALLED_APPS列表中：

INSTALLED_APPS = (
    # 其他应用...
    'explorer',
)

配置URL路由

在项目的urls.py文件中添加以下路由配置：

from django.urls import path, include

urlpatterns = [
    # 其他路由...
    path('explorer/', include('explorer.urls')),
]

4. 数据库迁移

运行以下命令创建必要的数据库表：

python manage.py migrate

5. 创建超级用户

创建一个超级用户以便访问管理界面：

python manage.py createsuperuser

6. 启动开发服务器

python manage.py runserver

现在，您可以通过访问http://127.0.0.1:8000/explorer/来使用Django SQL Explorer。

静态文件配置

Django SQL Explorer需要正确的STATIC_URL设置。如果您使用Django Storages等第三方存储后端，请确保STATIC_URL指向正确的静态文件位置。

AI SQL助手功能

Django SQL Explorer提供了AI辅助功能，可以帮助您优化SQL查询。要启用此功能：

1. 安装必要的依赖：

pip install openai tiktoken

2. 在settings.py中配置OpenAI API密钥：

EXPLORER_AI_API_KEY = '您的OpenAI_API_KEY'
# 或从环境变量获取
EXPLORER_AI_API_KEY = os.environ.get("OPENAI_API_KEY")

3. 可选：自定义AI模型和API端点

EXPLORER_ASSISTANT_MODEL = {
    "name": "mistralai/mixtral-8x7b-instruct:nitro",
    "max_tokens": 32768
}
EXPLORER_ASSISTANT_BASE_URL = "https://openrouter.ai/api/v1"
EXPLORER_AI_API_KEY = os.environ.get("OPENROUTER_API_KEY")

高级配置选项

参数化查询行为

默认情况下，参数化查询会自动使用默认参数值运行。如果您希望用户先检查参数再执行查询，可以设置：

EXPLORER_AUTORUN_QUERY_WITH_PARAMS = False

Celery集成

如需使用快照、邮件发送查询等高级功能，需要安装Celery并设置：

EXPLORER_TASKS_ENABLED = True

从源码安装

由于前端资源需要构建，不建议直接从源码仓库通过pip安装。如需从源码运行，请克隆仓库并按照开发文档中的说明进行操作。

后续步骤

安装完成后，您可以：

1. 在/explorer/connections/new/添加数据库连接
2. 开始编写和执行SQL查询
3. 探索各种数据分析和可视化功能

Django SQL Explorer为您的Django项目提供了强大的数据探索能力，是开发者和数据分析师的理想工具。

django-sql-explorer Easily share data across your company via SQL queries. From Grove Collab. 项目地址: https://gitcode.com/gh_mirrors/dja/django-sql-explorer