前提条件

• 组织版本为企业版。
• 目前仅支持MySQL、PostgreSQL、DRDS数据库。

功能介绍

在项目开发阶段，业务逻辑和数据显示依赖于数据库的SQL操作。上线前，必须对所有SQL进行严格审核，以防不规范语句影响生产环境。为避免人工审核的低效和资源浪费，DMS提供了SQL审核功能，依据自定义安全规则提出优化建议，如设定表需有主键、主键类型限制等，以提高研发效率和保障数据库规范。SQL相关规则详细配置请参考SQL规范。

操作步骤

创建SQL审核工单

1. 登录DMS控制台。
2. 在左侧导航栏，选择SQL治理 > SQL审核 ，进入SQL审核管理页面。
3. 单击SQL审核按钮，弹出SQL审核工单填写界面，工单需要输入的内容说明见下表1。
4. 填写完SQL审核工单后，单击提交按钮，即完成工单的提交，进入SQL规范检查。
5. SQL审核工单检查通过之后，会自动进入审批流程。管理员将再次确认SQL，审批完成则工单流程结束。

表1 SQL审核工单输入内容说明

输入内容
说明
目标实例     
必填项，选择执行SQL语句的目标实例，目前支持MySQL，PostgreSQL，DRDS数据源。
目标数据库

选填项，选择执行SQL语句的目标数据库。如果未选中目标数据库，则会只检查“离线规则”，“在线规则”和“离线规则”详见 SQL规范。
关联人         

选填项，选择需要看到此工单的用户名，关联人可在工单列表页面查看到此工单。
审核内容
必填项，上传或编辑审核内容。
注意
支持单个SQL文件、MyBatis框架XML文件或多文件打包成ZIP。单SQL/XML文件最大2M。ZIP不可超过20M，路径深度最大5层，最多包含200个文件。
如果上传文件为单文件，上传的文件内容将自动解析至输入框中，覆盖输入框内原有内容；如果上传文件为ZIP，上传的文件目录、文件名将自动展示到页面。
工单说明 
描述工单备注内容。

说明
检查结果中如果有强制改进项，用户需要改进该项命中的SQL并重新检查通过之后，才能进入审批流程。
如果有建议改进项，不会阻断任务流程，但会出现改进建议。
强制改进和建议改进的定义，详见SQL规范。

查看SQL审核工单列表

1. 用户登录DMS系统。
2. 在左侧菜单栏依次选择 SQL治理 > SQL审核 。
3. 系统显示SQL审核工单列表。

查看SQL审核工单详情

1. 用户登录DMS系统。
2. 在左侧菜单栏依次选择 SQL治理 > SQL审核 。
3. 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
4. 点击 导出审核详情，可将该工单的所有SQL内容及审核结果以html形式导出下载。

复制创建SQL审核工单

1. 用户登录DMS系统。
2. 在左侧菜单栏依次选择 SQL治理 > SQL审核 。
3. 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
4. 点击顶部复制创建按钮，进入到工单编辑界面。
5. 填写和修改工单信息，点击提交完成SQL审核工单的复制创建。

撤回SQL审核工单

1. 用户登录DMS系统。
2. 在左侧菜单栏依次选择 SQL治理 > SQL审核 。
3. 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
4. 点击底部撤回按钮，系统显示SQL审核工单撤回弹窗。
5. 点击确定按钮，完成SQL审核工单的撤回。

注意
当SQL审核工单任务状态为检查中、审批中时，才能进行撤回操作。

编辑SQL审核工单

1. 用户登录DMS系统。
2. 在左侧菜单栏依次选择 SQL治理 > SQL审核 。
3. 点击要编辑的工单操作列编辑按钮，系统显示SQL审核工单编辑页面。
4. SQL审核工单状态如果展示为检查不通过，可通过SQL审核工单列表或详情页点击编辑按钮，进入工单内容编辑页面。
5. SQL审核工单的编辑页，可通过审核内容一栏调整全部SQL内容，也可通过点击检查结果下的调整SQL按钮，修改需要改进的单条SQL。
6. 修改完毕，点击弹窗下方的立即检查或确定按钮，对SQL内容重新审核。
7. 如需下载当前提交的全部SQL语句，请点击检查结果下方的下载按钮。

注意
只有当SQL审核工单任务状态为检查不通过时，才能进行编辑操作。

重试SQL审核工单

1. 用户登录DMS系统。
2. 在左侧菜单栏依次选择 SQL治理 > SQL审核 。
3. 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
4. 点击底部重试工单按钮，系统显示SQL审核工单重试弹窗。
5. 点击确定按钮，完成SQL审核工单的重试。

注意
只有当SQL审核工单任务状态为检查不通过时，才能进行重试操作。