Archery - SQL审核查询平台

简介

Archery是一个功能全面的SQL审核查询平台，提供数据库查询、审核、执行、备份等一体化管理功能，支持多种主流数据库系统。

功能清单

快速开始

系统体验

在线体验

Docker部署方案

1. 准备运行配置

具体可参考：[***]

2. 启动容器

下载Releases文件，解压后进入docker-compose文件夹执行以下命令：

bash
# 启动容器
docker-compose -f docker-compose.yml up -d

# 表结构初始化
docker exec -ti archery /bin/bash
cd /opt/archery
source /opt/venv4archery/bin/activate
python3 manage.py makemigrations sql
python3 manage.py migrate

# 数据初始化
python3 manage.py dbshell<sql/fixtures/auth_group.sql
python3 manage.py dbshell<src/init_sql/mysql_slow_query_review.sql

# 创建管理用户
python3 manage.py createsuperuser

# 重启服务
docker restart archery

# 日志查看和问题排查
docker logs archery -f --tail=10
logs/archery.log

3. 访问系统

部署完成后，通过以下地址访问：[***]

手动安装

详细部署说明请参考：[***]

运行测试

bash
python manage.py test -v 3

依赖清单

框架

• Django
• Bootstrap
• jQuery

前端组件

• 菜单栏：metisMenu
• 主题：sb-admin-2
• 编辑器：ace
• SQL美化：sql-formatter
• 表格：bootstrap-table
• 表格编辑：bootstrap-editable
• 下拉菜单：bootstrap-select
• 文件上传：bootstrap-fileinput
• 时间选择：bootstrap-datetimepicker
• 日期选择：daterangepicker
• 开关：bootstrap-switch
• Markdown展示：marked

服务端

• 队列任务：django-q
• MySQL连接器：mysqlclient-python
• MsSQL连接器：pyodbc
• Redis连接器：redis-py
• PostgreSQL连接器：psycopg2
• Oracle连接器：cx_Oracle
• MongoDB连接器：pymongo
• Phoenix连接器：phoenixdb
• ODPS连接器：pyodps
• ClickHouse连接器：clickhouse-driver
• SQL解析/切分/类型判断：sqlparse
• MySQL Binlog解析/回滚：python-mysql-replication
• LDAP：django-auth-ldap
• 序列化：simplejson
• 时间处理：python-dateutil

功能依赖

• 可视化：pyecharts
• MySQL审核/执行/备份：goInception|inception
• MySQL索引优化：SQLAdvisor
• SQL优化/压缩：SOAR
• My2SQL：my2sql
• 表结构同步：SchemaSync
• 慢日志解析展示：pt-query-digest|aquila_v2
• 大表DDL：gh-ost|pt-online-schema-change
• MyBatis XML解析：mybatis-mapper2sql
• RDS管理：aliyun-openapi-python-sdk
• 数据加密：django-mirage-field

贡献代码

可查阅主页的开发计划以及依赖清单，在对应Issues中回复认领，或者直接提交PR。贡献包括但不限于以下方式：

• Wiki文档（开放编辑）
• Bug修复
• 新功能提交
• 代码优化
• 测试用例完善

交流反馈

• 使用咨询、需求沟通：Discussions
• Bug提交：Issues

致谢

• archer：Archery项目是基于archer二次开发而来
• goInception：一个集审核、执行、备份及生成回滚语句于一身的MySQL运维工具
• JetBrains Open Source：为项目提供免费的IDE授权