详解Yearning SQL审核平台功能模块设计

Yearning SQL审核平台目前兼容99%的Mysql 标准SQL语法。

已知不支持的语句类型有:

下面对其中的功能模块做一下介绍，以下基于Yearning 2.0版本。

1、dashboard

dashboard主要展示Yearning各项数据包括用户数/数据源数/工单数/查询数以及其他图表,个人信息栏内用户可以修改密码/邮箱/真实姓名,同时可以查看该用户权限以及申请权限。

2、我的工单

展示用户提交的工单信息，对于执行失败/驳回的工单点击详细信息后可以重新修改sql并提交，对于执行成功的工单可以查看回滚语句并且快速提交SQL

3、工单-DDL

具有以下功能：

1)DDL相关SQL提交审核

2)查看表结构/索引

3)SQL语法高亮/自动补全

如果想获取表结构详细信息,必须选填表名并完整填写工单信息。所有的SQL只有在检测后错误等级为0时提交按钮才会激活,如下拉列表框内没有相关数据源显示请联系管理员是否赋予相应数据源权限

4、工单--DML

具备以下功能：

1）DML相关SQL提交审核

2）SQL语法高亮/自动补全

所有的SQL只有在检测后错误等级为0时提交按钮才会激活，如下拉列表框内没有相关数据源显示请联系管理员是否赋予相应数据源权限

5、查询

具备以下功能：

1）查询/导出数据

2）SQL语法高亮/自动补全

3）快速DML语句提交

如果开启查询审核,提交该查询申请后需对应审核人同意后方可查询，超级管理员在设置页面开启数据导出功能后,查询申请页面才会显示数据导出按钮（默认为.csv格式），获取表结构功能必须点击相应表名此为前置条件，快速提交功能仅支持DML语句，如下拉列表框内没有相关数据源显示请联系管理员是否赋予相应数据源权限

1、工单审核

功能：DDL/DML管理员审核并执行

实时刷新开关默认打开,如需删除记录请先关闭该开关。如定时工单的时间小于当前时间,执行该工单将会立即执行，目前仅支持延时工单中止,其他工单执行后无法中止！

2、查询审核

功能：用户查询审核

点击全部中止按钮将会中止所有用户的查询权限 如没有在设置页面开启查询审核开关，则默认用户查询申请提交后自动获得查询权限。 用户查询时限在设置页面进行设置

3、权限审核

功能：用户权限审核

权限由用户在首页个人信息处自主申请,管理员可在该审核页面决定是否给予用户申请的权限，由于用户可能存在胡乱申请权限的问题，所以 管理员在查看用户权限申请工单的同时可对工单申请的权限进行修改，确定具体的权限给予 。

1、工单审计

主要是审计工单的执行情况，记录工单的执行时间、申请人、执行人等信息。

2、查询审计

针对数据库查询记录做审计

1、用户

功能：创建/修改/删除用户

当多级审核关闭后系统并不会自动将角色为执行人的用户重置角色，需要自行重置相应用户角色

2、数据库

功能：添加/编辑/删除 数据源

所有添加的数据源应在添加之前点击测试连接按钮进行连接性测试,保证连接性。

数据源分为 查询数据源/非查询数据源 。查询数据源仅会出现在细粒度权限的查询数据源范围内。非查询数据源同理。（对于查询与执行数据源应拆分为二,保障线上执行数据源不会因为查询慢sql影响业务），此类别添加后 无法通过编辑进行修改 ，需要慎重添加。

3、用户权限

功能：用户权限修改/清空

批量赋权仅支持角色为使用人的用户。由于批量赋权为覆盖更新，仅适合在用户权限为空时使用。

4、设置

功能：

在配置填写无误后点击测试按钮进行相关测试, 使用消息推送前必须先打开对应消息推送开关,否则Yearning不会进行推送

5、审核规则

功能:设置SQL检测规则

保存后即时生效

后面会分享更多devops和DBA方面的内容，感兴趣的朋友可以关注下~

通过SQLE的产品结构图我们可以看到，SQLE 的界面设计较简洁，工作台可以看到与自己相关的待办工作；首页列表放置核心功能【工单】审核，其它功能收集到平台管理中；【规则】可以考虑收入到【平台管理】中；【审核计划】也可以考虑收入到【平台管理】中，审核的结果可以集成到工单中，方便统一进行处理。

通过 SQLE 的流程图可以看到，整体流程分为两个两个部分，一个是基础配置，配置好了基础配置以后，就可以执行上线流程了；对于审核不合格的功能依旧可以执行工单，没有起到自动审核的意义，对于ERROR级别的错误可以自动驳回不与上线；进入工单页面后不能很好的发现审核 *** 作按钮（工单进度部分），需要下拉窗口才能发现；可以把审核 *** 作放到审核结果列表后面加一个 *** 作列，体验会更加友好。下图为缩放67%后才能看到下面的审核 *** 作.

（1）创建SQL工单-SQL语句不支持输入联想，建议增加输入联想，提高录入效率

（2）创建SQL工单-SQL语句对于明显语法错误不能及时提示，建议增加语法错误提示，提前发现明显问题

（3）创建SQL工单-SQL语句输入框高度过高，点击审核后不方便查看到结果，建议降低高度增加宽度

（4）创建SQL工单-工单不支持自定义上线时间，同时也不支持定时上线

由于时间有限，仅是个人测试体验；SQLE 整体设计不错，符合现在主流平台的各方面特征；主要几个设计点我比较喜欢：

---