Yearning SQL审核平台

　　Yearning提供数据库审核功能，可以直接在软件上提交设计的工单，软件界面显示我的工单、工单提交、查询、审核、记录、管理等功能，用户直接在软件上编辑工单信息，提交到软件以后就可以在软件上分析数据库语句，可以对SQL语句审核，可以查看审核的内容，可以查看SQL回滚信息，可以自定义工作流，软件显示当前平台用户数量，显示数据源、显示工单总数，显示查询总数，相关的数据都直接在界面上统计，可以查看数据统计图表，可以查看工单走势，具有的功能还是很多的，适合需要对MySQL数据库查询的朋友使用，支持大部分MySQL标准语法SQL查询，让用户可以获取更方便简单的SQL语句审核方案，如果你需要对数据库SQL语句审核就可以下载这款软件！

软件功能

　　SQL 查询

　　查询工单

　　导出

　　自动补全，智能提示

　　查询语句审计

　　SQL 审核

　　流程化工单

　　SQL 语句检测与执行

　　SQL 回滚

　　历史审核记录

　　自定义审核层级

　　推送

　　E-mail 工单推送

　　钉钉 webhook 机器人工单推送

　　用户权限及管理

　　角色划分

　　基于用户的细粒度权限

　　注册

　　其他

　　todoList

　　LDAP 登录

　　动态审核规则配置

　　AutoTask 自动执行

软件特色

　　向往功能

　　渴望拥有多个实用型功能。助力DBA提升工作自动化，标准化。

　　渴望拥有以下功能：

　　自动化SQL语句审核，可对SQL进行自动检测并执行

　　DDL / DML语句执行后自动生成回滚语句

　　审核/查询审核功能

　　支持LDAP登录/钉钉及邮件消息推送

　　支持自定义审核工作流

　　支持细粒度权限分配

　　语法支持

　　迄今为止，已兼容99％的Mysql标准SQL语法。但由于审核逻辑等因素的限制，对某些SQL语句并不能保证得到正确的反馈。

　　复杂的查询语句（多表，多函数，非必现。并不是所有复杂语句不支持）

　　外键相关语句

　　不支持跨库DML语句的回滚

　　存储过程/扭曲

　　仅代表当前语法支持进度，而不是未来完成度。

安装方法

　　Yearning 目录结构

　　1.填写配置文件

　　关于 SecretKey

　　SecretKey 是 token/数据库密码加密/解密的 salt。

　　建议所有用户在初次安装 Yearning 之前将 SecretKey 更改(不更改将存在安全风险)

　　格式: 大小写字母均可, 长度必须为 16 位 如长度不是16位将会导致无法新建数据源

　　特别注意:

　　此 key 仅可在初次安装时更改!之后不可再次更改!如再次更改会导致之前已存放的数据源密码无法解密,最终导致无法获取相关数据源信息

　　使用帮助

　　2.初始化数据结构

　　./Yearning -m

　　请务必在-s 启动前首先执行-m 初始化操作！

　　如要再次初始化，请先把 yearning 库下所有表删除，否则重复执行无效

　　3.启动服务

　　服务更新

　　Yearning采用自动表结构同步 无需手动更新表结构。只需停止原服务并替换安装包后重新启动即可(需将dist目录以及Yearning二进制文件都进行替换)

　　如遇删除字段操作的变动需要执行以下命令。具体是否需要做此操作，请详见相应版本的更新公告(目前该情况只出现于2.1.0以下版本升级到2.1.0以上版本)

　　./Yearning -x

　　对于2.3.0以下版本升级到2.3.0以上版本的操作，在执行完替换与启动之后，还需执行以下命令。

　　./Yearning -k

使用准备

　　在正式使用Yearning前,你需要先设置如下setup(请务必花几分钟时间阅读!)。

　　1、创建用户并确认其角色

　　2、创建权限组并将权限组赋予给对应的用户

　　3、添加数据源信息

　　4、为数据源创建自定义审核规则

　　5、在设置页面配置各项配置信息

　　6、根据需求调整自定义审核规则

　　创建用户并确认其角色

　　创建用户

　　在Yearning中用户可以通过以下方式创建:

　　1、在 管理->用户 页面admin用户自行创建用户。

　　2、打开 管理->设置 页面中的允许注册配置并保存。 由注册人自行点击yearning登录页面左上角注册按钮进行注册。

　　3、配置 管理->设置 页面中的Ldap的信息并保存。 ldap用户可在yearning登录页面中勾选ldap登录进行用户注册/登录操作。

　　角色

　　Yearning的用户角色分别为:提交人，操作人，超级管理员(仅admin用户) 三类。

　　提交人: 仅拥有提交的工单,查询的功能

　　操作人: 在提交人权限的基础上,拥有审核/执行工单的功能

　　超级管理员: 在前两者的权限基础上,拥有平台管理/配置/审核规则设置等管理员权限。

　　注意: 角色是粗粒度的，其目的是为了划分出多个不同属性的用户群从而对不同的用户展示处不同的前端页面导航信息。而更细粒度的权限(例如:允许用户查询哪个数据源,允许用户提交哪个数据源的工单)则通过权限组来进行赋权。

　　对于除了admin用户以外的所有用户，在创建账号时(通过注册/ldap登录)统一为提交人角色。如需更改角色应由admin用户通过 管理->用户 页面进行更改。

　　创建权限组并将权限组赋予给对应的用户

　　通过管理->权限组 页面，admin可以创建/编辑/删除权限组。权限组提供了多种细粒度的权限管控(yearning目前权限管控仅下沉到数据源级别)如下所示:

　　1、允许DDL工单提交的数据源范围

　　2、允许DML工单提交的数据源范围

　　3、允许查询工单提交的数据源范围

　　4、查询的上级审核人范围

　　创建完权限组后请通过管理->用户页面，选择你需要赋予权限组的用户点击该用户对应的权限按钮进行权限组赋权。

　　一个用户可以被赋予多个权限组,多权限组下该用户会集成2个权限组的全部权限

　　一个权限组也可以对多个用户进行赋权

　　添加数据源信息

　　通过管理->数据库 页面，admin可以创建/编辑/删除数据源。数据源为一个Mysql实例，数据库共分为读/写/读写三大种类。如果希望该数据源既可处理DDL/DML工单又能进行查询则该数据源应设置为读写，反之根据自己的需求可以设置为读/写。

　　尤其要注意: Yearning不支持一些特殊字符串例如@，这是由于转义以及可能会带来的pt-osc执行错误而不得不规避的问题，建议用户单独创建一个新的mysql用户用来对接Yearning平台

　　为数据源创建自定义审核规则

　　通过管理->流程 页面，admin可以编辑数据源的流程。

　　Yearning以数据源为单元，可对不同的数据源配置不同的审核流程。

　　Yearning 最多支持7层的审核流程，但必须注意的是流程的开头必然是提交人阶段，流程的结束必然是执行阶段。否则将会导致流程错乱！

　　更改流程时请确保该数据源下的工单都已处理完毕，否则可能会引起流程错乱！

　　如没有将对应数据源配置流程则用户无法对这个数据源进行任何DDL/DML工单提交操作

　　在设置页面配置各项配置信息

　　通过管理->设置 页面，admin可以配置Yearning的多项配置。

　　这里将介绍几个重点配置:

　　1、查询limit上限: 该设置为全局查询最大的limit限制，默认为1000.这意味着通过Yearning进行的查询最多只会查询1000条。如需提高此阀值可直接修改这个配置。

　　更多的注意事项可通过本文档的 各模块注意事项->管理员模块->设置 查看

　　根据需求调整自定义审核规则

　　通过管理->审核规则 页面，admin可以设置Yearning多达几十项的审核规则且每一项审核规则都有详细的描述。

　　对于PT-OSC的设置请参考具体生产实践经验

更新日志

　　新增指定表名前缀审核规则(sponsor版本)

　　新增支持外键审核(sponsor版本)

　　支持企业微信消息推送 (Sponsor 版本)

　　审核人支持移动端审核(sponsor版本)

　　审核规则新增基于主键回滚开关(sponsor版本)

　　前端文件不再需要单独部署(已融入二进制中)

　　允许drop/create视图并可生成回滚语句

　　修复首页饼图文案展示错误

　　修复首页趋势图数据倒序的问题

　　修复autotask分页问题

　　修复之前发现的脱敏问题

　　修复DML不同库的语句只会生成最后一条的问题

　　修复DML多条语句中某条符合AutoTask时整个工单执行的逻辑错误

　　修复多条语句执行执行并有部分错误时 正确语句反馈信息错误的问题

　　修复加载标识符载入错误

　　修复结束查询后没有清空工单信息的问题