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项目中执行SQL查询并可视化结果。本文将全面解析该项目的配置选项，帮助开发者根据实际需求进行安全且高效的配置。

核心安全配置

SQL黑名单机制

为了防止执行危险SQL操作，项目提供了黑名单机制：

EXPLORER_SQL_BLACKLIST = (
    # 数据操作语言(DML)
    'COMMIT', 'DELETE', 'INSERT', 'MERGE', 'REPLACE', 
    'ROLLBACK', 'SET', 'START', 'UPDATE', 'UPSERT',
    
    # 数据定义语言(DDL)
    'ALTER', 'CREATE', 'DROP', 'RENAME', 'TRUNCATE',
    
    # 数据控制语言(DCL)
    'GRANT', 'REVOKE'
)

技术解析：

黑名单分为三类SQL语句：数据操作、结构修改和权限控制
默认配置覆盖了所有可能破坏数据完整性的操作
在生产环境中不应随意修改此配置

权限控制配置

项目提供两级权限控制：

# 查看和执行查询的权限
EXPLORER_PERMISSION_VIEW = lambda r: r.user.is_staff

# 增删改查询的权限
EXPLORER_PERMISSION_CHANGE = lambda r: r.user.is_staff

最佳实践建议：

可根据企业RBAC系统自定义这些lambda函数
建议结合Django的权限系统进行更细粒度的控制
生产环境应严格限制修改权限

数据展示配置

基础展示设置

# 默认显示行数
EXPLORER_DEFAULT_ROWS = 1000

# 最近查询显示数量
EXPLORER_RECENT_QUERY_COUNT = 10

性能考量：

大数据量查询时应适当减少默认行数
可通过EXPLORER_DEFAULT_ROWS平衡性能与用户体验

数据库模式展示控制

# 包含的表前缀
EXPLORER_SCHEMA_INCLUDE_TABLE_PREFIXES = None

# 排除的表前缀
EXPLORER_SCHEMA_EXCLUDE_TABLE_PREFIXES = (
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.admin'
)

# 是否包含视图
EXPLORER_SCHEMA_INCLUDE_VIEWS = False

使用场景：

大型数据库可指定前缀缩小模式展示范围
排除Django内置表可简化界面
视图展示需谨慎，可能包含复杂逻辑

高级功能配置

异步处理配置

# 异步生成数据库模式
EXPLORER_ASYNC_SCHEMA = False

# Celery任务支持
EXPLORER_TASKS_ENABLED = False

实现要点：

异步模式需要Celery支持
适合大型数据库模式生成场景
启用前需确保Celery配置正确

数据导出选项

EXPLORER_DATA_EXPORTERS = [
    ('csv', 'explorer.exporters.CSVExporter'),
    ('excel', 'explorer.exporters.ExcelExporter'),
    ('json', 'explorer.exporters.JSONExporter')
]

扩展建议：

可自定义导出器实现特定格式需求
Excel导出需要xlsxwriter支持
大数据量导出应考虑分页或异步处理

云存储集成

S3配置详解

# 基础配置
EXPLORER_S3_ACCESS_KEY = None
EXPLORER_S3_SECRET_KEY = None
EXPLORER_S3_BUCKET = None
EXPLORER_S3_REGION = 'us-east-1'

# 高级配置
EXPLORER_S3_ENDPOINT_URL = '自定义端点URL'
EXPLORER_S3_DESTINATION = 'explorer/query'
EXPLORER_S3_LINK_EXPIRATION = 3600
EXPLORER_S3_SIGNATURE_VERSION = 's3v4'

企业级配置建议：

使用IAM角色替代直接密钥更安全
私有云部署需正确设置端点URL
链接过期时间应根据业务需求调整
v4签名版本支持所有AWS区域

用户自定义连接

# 启用用户自定义连接
EXPLORER_DB_CONNECTIONS_ENABLED = False

# 启用用户上传
EXPLORER_USER_UPLOADS_ENABLED = False

# 最大上传大小(默认500MB)
EXPLORER_MAX_UPLOAD_SIZE = 500 * 1024 * 1024

安全考虑：

内部工具可考虑启用此功能
应配合严格的权限控制使用
上传大小限制可防止资源耗尽

AI辅助功能

# SQL助手配置
EXPLORER_AI_API_KEY = None
EXPLORER_ASSISTANT_BASE_URL = "https://api.openai.com/v1"
EXPLORER_ASSISTANT_MODEL = {
    "name": "gpt-4o",
    "max_tokens": 128000
}

使用建议：