审核文件详情

操作场景

查看上传的审核文件详细信息。

前提条件

有已上传的审核文件。

操作步骤

登录UGO控制台。
单击左侧导航栏“SQL审核 > 语句审核 > 审核文件”，进入审核文件页面。
单击待查看任务“操作 > 查看详情”。显示该任务的审核文件信息与采集出的SQL语句列表，也可“导出”SQL语句。
- 导出：选定待导出的单/多条SQL语句后单击“导出”，可将所选的SQL语句导出为.tar.gz的压缩包文件。
  - 默认导出全部SQL语句，也可勾选复选框导出选定的SQL语句内容，或者通过筛选框进行条件筛选后导出SQL语句。
  - 导出默认勾选“导出的Excel中包含原始SQL”，若原始“SQL语句”较大建议不勾选此选项。
  - 导出的SQL文件中，原始的“SQL语句”较大时，则将原始的“SQL语句”以单独的文件进行保存，Excel文件中的“SQL文本”列显示保存的文件名。
  - 允许导出到Excel的最大对象数量为5000条。
  - 导出的依赖表结构超过30000字符时，会额外导出为sql文件。
- 审核文件信息：显示上传的文件名、任务审核状态、数据源信息等。
- SQL列表：显示SQL ID、SQL语句、SQL说明、风险级别、状态等。
图1 任务审核详情
- 单击“规则模板”后的值，可跳转到具体的模板信息。
- 其中“状态”显示当前语句的审核状态，语句审核状态有以下几种：
  - 新建：刚采集出来的SQL，等待审核。
  - 分析完毕：审核完成。
  - 分析失败：SQL语句解析失败。
  - 审核错误：审核过程出现异常。
  - 忽略：暂不支持该SQL语句的审核或单条SQL语句大小超出阈值。默认阈值为100KB。
- 解析失败原因：
  - line:1, position:14, token:table：表示SQL语句中存在关键字“table”。
  - line:1, position:3, token:<EOF>：表示SQL语句未输入完整。
单击具体SQL语句后的“审核详情”。显示该SQL语句的基本信息、违反规则与表结构等。
- 若采集到多条SQL语句，可单击“上一条”或“下一条”切换查看。
  图2 SQL语句审核详情
- 基本信息：显示该SQL的具体SQL语句与SQL说明。
- 违反规则：依据所选的规则模板，给出该SQL语句违反规则的规则名、风险级别以及建议等。
  单击“问题片段”可在审核文本中高亮显示此内容；再次单击即可取消。PL/SQL可能存在多个问题片段，单击左侧，展示所有问题片段。
- 未匹配规则：因为未选择数据源、数据源连接失败、用户权限不足、Schema选择错误、或者表不存在原因，导致依赖源库相关的规则项未能匹配。展示信息包括：规则名、风险级别、未匹配原因等。
- 表结构：展示审核SQL语句中依赖的表结构信息，包括对象名、对象类型、属主等。
- 执行计划：展示SELECT、UPDATE、DELETE、INSERT语句的执行计划。
  
  用户需要有系统表和系统视图读取的权限才能获取表结构。
  
  GaussDB会从以下系统表中获取依赖的表结构：tables，pg_class，pg_namespace，relnamespace，pgxc_class，pg_settings，pg_get_viewdef，columns，pg_tables，pg_index，table_constraints，pg_partition，pg_get_tabledef，check_constraints，key_column_usage，pg_get_keywords，gs_package，db_constraints，adm_ind_columns等。
  
  MySQL会从以下系统表中获取依赖的表结构：information_schema.tables，information_schema.columns，information_schema.statistics，information_schema.table_constraints等。