Django SQL Dashboard 使用教程

1. 项目介绍

Django SQL Dashboard 是一个用于构建基于 Django 的 SQL 查询仪表盘的开源项目。它允许用户通过执行原始 SQL 查询来创建仪表盘，适用于数据分析、调试和报告等场景。该项目提供了一个安全的、只读的接口，可以直接与 PostgreSQL 数据库交互，并将查询结果可视化。

主要功能

• 安全执行 SQL 查询：用户可以在浏览器中安全地执行只读 SQL 查询，并查看结果。
• 查询书签和共享：用户可以书签查询，并与其他团队成员共享链接。
• 保存仪表盘：用户可以从查询创建保存的仪表盘，并控制谁可以查看和编辑这些仪表盘。
• 交互式仪表盘：支持命名参数，如 select * from entries where id = %(id)s，可以快速创建交互式仪表盘。
• 数据可视化：支持从 SQL 查询生成条形图、进度条等，并可以使用 Django 模板系统创建自定义仪表盘小部件。
• 数据导出：支持将 SQL 查询结果导出为 CSV 或 TSV 文件，并使用 PostgreSQL 服务器端游标高效地流式传输大量数据。

2. 项目快速启动

安装

首先，确保你已经安装了 Python 和 Django。然后，使用 pip 安装 django-sql-dashboard：

pip install django-sql-dashboard

配置

在 Django 项目的 settings.py 文件中添加 django_sql_dashboard 到 INSTALLED_APPS：

INSTALLED_APPS = [
    ...
    'django_sql_dashboard',
    ...
]

接下来，运行数据库迁移：

python manage.py migrate

配置只读 PostgreSQL 用户

为了安全起见，建议配置一个只读的 PostgreSQL 用户。在 settings.py 中添加以下配置：

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'your_database_name',
        'USER': 'your_readonly_user',
        'PASSWORD': 'your_readonly_password',
        'HOST': 'your_database_host',
        'PORT': 'your_database_port',
    },
    'dashboard': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'your_database_name',
        'USER': 'your_readonly_user',
        'PASSWORD': 'your_readonly_password',
        'HOST': 'your_database_host',
        'PORT': 'your_database_port',
    },
}

运行项目

启动 Django 开发服务器：

python manage.py runserver

访问 http://127.0.0.1:8000/dashboard/，你将看到 Django SQL Dashboard 的界面。

3. 应用案例和最佳实践

应用案例

• 数据分析：使用 Django SQL Dashboard 进行数据分析，生成报告并共享给团队成员。
• 调试：在开发过程中，使用仪表盘快速查看数据库中的数据，帮助调试代码。
• 仪表盘共享：创建并共享仪表盘，使团队成员能够快速访问和分析数据。

最佳实践

• 安全配置：确保使用只读用户访问数据库，避免潜在的安全风险。
• 权限管理：使用 Django 的权限系统控制谁可以访问和编辑仪表盘。
• 数据导出：定期导出数据并保存为 CSV 或 TSV 文件，以便进行离线分析。

4. 典型生态项目

• Django SQL Explorer：提供类似的功能，但支持更多数据库后端，如 MySQL、SQLite 等。
• Datasette：一个用于探索和发布数据的工具，与 Django SQL Dashboard 有相似的应用场景。
• Django Admin：Django 自带的管理界面，可以与 Django SQL Dashboard 结合使用，提供更全面的管理功能。

通过以上步骤，你可以快速上手并使用 Django SQL Dashboard 构建强大的数据分析和报告仪表盘。