SOAR

SOAR(SQL Optimizer And Rewriter) 是一个对 SQL 进行优化和改写的自动化工具。 由小米人工智能与云平台的数据库团队开发与维护。
开源地址:https://github.com/XiaoMi/soar
配置文件说明:https://github.com/XiaoMi/soa...
说明文档及示例:https://github.com/XiaoMi/soa...

功能及特点

  • 跨平台支持(支持 Linux, Mac 环境,Windows 环境理论上也支持,不过未全面测试)
  • 目前只支持 MySQL 语法族协议的 SQL 优化
  • 支持基于启发式算法的语句优化
  • 支持复杂查询的多列索引优化(UPDATE, INSERT, DELETE, SELECT)
  • 支持 EXPLAIN 信息丰富解读
  • 支持 SQL 指纹、压缩和美化
  • 支持同一张表多条 ALTER 请求合并
  • 支持自定义规则的 SQL 改写

场景描述

场景描述参考链接:https://blog.csdn.net/weixin_...

场景 线上环境 测试环境 应用类型
场景一 日常优化,完整的建议,推荐
场景二 新申请资源,环境初始化测试
场景三 盲测,试用,无EXPLAN和索引建议
场景四 用线上环境当测试环境,不推荐
  • 场景一
    这个场景是我们日常工作中最常见的场景,它主要应用于线上服务日常创建表或表结构表更。

    SOAR对SQL进行分析时,会先从SQL语句中获取基本信息,然后将所有涉及到的库表结构元数据从线上环境中获取,并同步到测试环境中进行更进一步的分析。在这个场景下,SOAR能提供最全面的功能支持。不仅能够输出110多项SQL检查,还能够对涉及到的库表进行索引分析,而且还可以输出EXPLAIN、PROFILE等信息来辅助DBA或开发者进行性能调优和问题定位。SQL改写也会依赖元数据的支持,在此场景下的功能是支持的最全面的。

  • 场景二
    这个场景适用于首次申请数据库资源的情况,此时还没有已经存在的线上环境与之相对应。

    在这个场景下,SQL文件主要包含的是建库建表语句,SOAR会根据DDL生成相应的测试环境,并从该环境中获取元数据进行优化分析。

  • 场景三
    在这一场景下由于没有配置线上环境和测试环境依赖,缺少很多分析时必要的元数据,且无法获取EXPLAIN等信息,在这种情况下SOAR将会进行功能降级,只给予部分不依赖数据库环境才能给出的建议(绝大部分的启发式建议和小部分SQL改写)。

    虽然在这个场景下服务的功能并不全面,但执行速度也是最快的,这种场景依然能提供110多种启发式建议,特别适合于对SQL本身的检测,比如作为一个本地化的SQL Linter IDE插件。

  • 场景四
    这一场景其实与场景二是一样的,在这一场景下只配置了线上环境,且开启了允许线上环境作为测试环境。那么在不指定测试环境的情况下SOAR将会把测试环境也指向线上环境。

    SOAR在进行评审时,为了保证多个客户端能够同时在一个环境内进行评审,会在测试环境中生成一个临时数据库,评审正常结束后再将该临时数据库删除。所以我们非常不建议将线上数据库环境做为测试环境,防止在某些未知的极端条件下对数据库产生严重影响。

快速入门

安装使用

依赖软件安装

一般依赖
  • Go 1.12+
  • git
高级依赖(面向开发人员)
  • mysql客户端版本需要与容器中MySQL版本相同,避免出现由于认证原因导致无法连接问题
  • dockerMySQL Server测试容器管理
  • govendorGo包管理
  • retool依赖外部代码质量静态检查工具二进制文件管理
windows下安装

具体见windows下载安装小米的sql分析工具soar


Tingtr
30 声望2 粉丝

PHPer