前提条件
- 组织版本为企业版。
- 目前仅支持MySQL数据库。
功能介绍
在项目开发阶段，业务逻辑和数据显示依赖于数据库的SQL操作。上线前，必须对所有SQL进行严格审核，以防不规范语句影响生产环境。为避免人工审核的低效和资源浪费，DMS提供了SQL审核功能，依据自定义安全规则提出优化建议，如设定表需有主键、主键类型限制等，以提高研发效率和保障数据库规范。SQL相关规则详细配置请参考SQL规范。
操作步骤
创建SQL审核工单
- 登录DMS控制台。
- 在左侧导航栏，选择开发空间 > SQL审核 ，进入SQL审核管理页面。
- 单击SQL审核按钮，弹出SQL审核工单填写界面，工单需要输入的内容说明见下表1。
- 填写完SQL审核工单后，单击提交按钮，即完成工单的提交，进入SQL规范检查。
- SQL审核工单预检查通过之后，会自动进入审批流程。管理员将再次确认SQL，审批完成则工单流程结束。
表1 SQL审核工单输入内容说明
输入内容 说明 目标数据库 必填项，选择执行SQL语句的目标数据库，目前仅支持MySQL数据源。 关联人 选填项，选择需要看到此工单的用户名，关联人可在我的工单页面查看到此工单。 提交SQL 必填项，输入需要审核的SQL语句，支持编写SQL或上传SQL文件。
注意
上传文件时支持SQL、TXT文件，大小不能超过1MB。
上传的文件内容将自动解析至SQL输入框中，覆盖输入框内原有内容。
单次SQL审核工单的SQL语句最多1000条。
工单说明 描述工单备注内容。
说明
预检查结果中如果有强制改进项，用户需要改进该项命中的SQL并重新检查通过之后，才能进入审批流程。
如果有建议改进项，不会阻断任务流程，但会出现改进建议。
强制改进和建议改进的定义，详见SQL规范。
查看SQL审核工单列表
- 用户登录DMS系统。
- 在左侧菜单栏依次选择 开发空间 > SQL审核 。
- 系统显示SQL审核工单列表。
查看SQL审核工单详情
- 用户登录DMS系统。
- 在左侧菜单栏依次选择 开发空间 > SQL审核 。
- 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
复制创建SQL审核工单
- 用户登录DMS系统。
- 在左侧菜单栏依次选择 开发空间 > SQL审核 。
- 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
- 点击顶部复制创建按钮，进入到工单编辑界面。
- 填写和修改工单信息，点击提交完成SQL审核工单的复制创建。
撤回SQL审核工单
- 用户登录DMS系统。
- 在左侧菜单栏依次选择 开发空间 > SQL审核 。
- 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
- 点击底部撤回按钮，系统显示SQL审核工单撤回弹窗。
- 点击确定按钮，完成SQL审核工单的撤回。
注意当SQL审核工单任务状态为提交成功、预检查中、审批中时，才能进行撤回操作。
编辑SQL审核工单
- 用户登录DMS系统。
- 在左侧菜单栏依次选择 开发空间 > SQL审核 。
- 点击要编辑的工单操作列编辑按钮，系统显示SQL审核工单编辑页面。
- SQL审核工单状态如果展示为预检查失败，可通过SQL审核工单列表或详情页点击编辑按钮，进入工单内容编辑页面。
- SQL审核工单的编辑页，可通过提交SQL一栏调整全部SQL内容，也可通过点击检查结果下的调整SQL按钮，修改需要改进的单条SQL。
- 修改完毕，点击重新检查或提交按钮，对SQL内容重新审核。
- 如需下载当前提交的全部SQL语句，请点击检查结果下方的下载按钮。
注意只有当SQL审核工单任务状态为预检查失败时，才能进行编辑操作。
重试SQL审核工单
- 用户登录DMS系统。
- 在左侧菜单栏依次选择 开发空间 > SQL审核 。
- 点击要查看的工单操作列详情按钮，系统显示SQL审核工单详情页面。
- 点击底部重试工单按钮，系统显示SQL审核工单重试弹窗。
- 点击确定按钮，完成SQL审核工单的重试。
注意只有当SQL审核工单任务状态为预检查失败时，才能进行重试操作。
