创建文本审核任务

操作场景

审核SQL语句是否符合规范及是否存在性能问题。

约束限制

• 规则的嵌套审核仅支持四种语法，详情可参见表1。
• With as只支持SELECT语句。
• 别名不能和实体表重名，且别名之间不能重名。
• 不支持审核视图中的表审核。
• 不支持审核数据库系统表及系统视图审核。
• 不支持审核含有“#”的MySQL语句。

  表1 支持的嵌套审核语句

  序号	SQL语句
  1	select id, (select 子查询) as name from table;
  2	select id from table where id in (select 子查询);
  3	select * from table1,(select 子查询);
  4	with e as (select 子查询) select * from e;

规则约束

• 所有涉及update、delete的规则项，均不支持多表操作审核。
• update、delete多表操作仅支持规则项：“不应用单条update、delete语句对多个表实现更新、删除操作”。
• 对于“在PL/pgSQL中，关键字建议大写，非关键字小写”、“sql语句中，关键字建议大写，非关键字小写”规则项，不要在以对象名作为非保留关键字的语句中使用，存在审核不准确情况，比如：SELECT ID FROM name，name是非保留关键字。
• 对于规则“对分区表执行交换分区、合并分区、分隔分区、清空分区、删除分区时，必须同步更新全局索引”，在用户修改数据库系统参数enable_gpi_auto_update后，该规则可能失效，请在数据库侧清理session，可登录到数据库中执行：

  CLEAN CONNECTION TO ALL FORCE FOR DATABASE db_name;

• “查询系统视图时，如果使用对象名作为筛选条件，对象名应使用小写”支持的系统视图参见表2。
• “谨慎删除数据库对象及清理数据”，其中阈值中支持审核SQL语法见表表3

  表2 视图审核

  视图名	所属schema	表示对象名的列
  adm_arguments	pg_catalog、sys	owner、object_name、package_name、argument_name
  adm_audit_object	pg_catalog、sys	username、owner、obj_name、action_name
  adm_audit_session	pg_catalog、sys	username、action_name
  adm_audit_statement	pg_catalog、sys	username、obj_name、action_name
  adm_col_comments	pg_catalog、sys	owner、table_name、column_name、schema
  adm_col_privs	pg_catalog、sys	grantor、owner、grantee、table_schema、table_name、column_name、privilege
  adm_coll_types	pg_catalog、sys	owner、type_name、elem_type_mod、elem_type_owner、elem_type_name
  adm_constraints	pg_catalog、sys	owner、constraint_name、table_name、index_owner、index_name
  adm_indexes	pg_catalog、sys	owner、index_name、table_name、table_owner、tablespace_name
  adm_ind_columns	pg_catalog、sys	index_owner、index_name、table_name、table_owner、column_name
  adm_objects	pg_catalog、sys	owner、object_name、subobject_name
  adm_procedures	pg_catalog、sys	owner、object_name、procedure_name、impltypeowner、impltypename
  adm_role_privs	pg_catalog、sys	grantee、granted_role
  adm_tab_col_statistics	pg_catalog、sys	owner、table_name、column_name、schema
  adm_roles	pg_catalog、sys	role
  adm_source	pg_catalog、sys	owner、name
  adm_sys_privs	pg_catalog、sys	grantee、privilege
  adm_tab_cols	pg_catalog、sys	owner、table_name、column_name、data_type_owner、schema、qualified_col_name
  adm_tab_privs	pg_catalog、sys	grantee、owner、table_name、grantor、privilege
  adm_tables	pg_catalog、sys	owner、table_name、tablespace_name
  adm_tab_columns	pg_catalog、sys	owner、table_name、column_name、data_type_owner、schema
  adm_tab_comments	pg_catalog、sys	owner、table_name、column_name、schema
  adm_tab_statistics	pg_catalog、sys	owner、table_name
  adm_triggers	pg_catalog、sys	owner、trigger_name、table_owner、table_name
  adm_type_attrs	pg_catalog、sys	type_name、attr_name、attr_type_name、character_set_name
  adm_types	pg_catalog、sys	owner、type_name
  adm_users	pg_catalog、sys	username、default_tablespace、temporary_tablespace、default_collation
  adm_views	pg_catalog、sys	owner、view_name
  db_all_tables	pg_catalog、sys	owner、table_name、tablespace_name
  db_arguments	pg_catalog、sys	owner、object_name、package_name、argument_name
  db_col_comments	pg_catalog、sys	owner、table_name、column_name、schema
  db_col_privs	pg_catalog、sys	grantor、owner、grantee、table_schema、table_name、column_name、privilege
  db_coll_types	pg_catalog、sys	owner、type_name、elem_type_mod、elem_type_owner、elem_type_name
  db_constraints	pg_catalog、sys	owner、constraint_name、table_name、index_owner、index_name
  db_indexes	pg_catalog、sys	owner、index_name、table_name、table_owner、tablespace_name
  db_ind_columns	pg_catalog、sys	index_owner、index_name、table_name、table_owner、column_name
  db_objects	pg_catalog、sys	owner、object_name、subobject_name
  db_procedures	pg_catalog、sys	owner、object_name
  db_tab_col_statistics	pg_catalog、sys	owner、table_name、column_name、schema
  db_source	pg_catalog、sys	owner、name
  db_tab_columns	pg_catalog、sys	owner、table_name、column_name、data_type_owner、schema
  db_tab_comments	pg_catalog、sys	owner、table_name、schema
  db_tables	pg_catalog、sys	owner、table_name、tablespace_name
  db_triggers	pg_catalog、sys	trigger_name、table_owner、table_name
  db_types	pg_catalog、sys	owner、type_name
  db_users	pg_catalog、sys	username
  db_views	pg_catalog、sys	owner、view_name
  dict	pg_catalog、sys	table_name
  dictionary	pg_catalog、sys	table_name
  my_col_comments	pg_catalog、sys	owner、table_name、column_name、schema
  my_col_privs	pg_catalog、sys	grantor、owner、grantee、table_schema、table_name、column_name、privilege
  my_coll_types	pg_catalog、sys	owner、type_name、elem_type_mod、elem_type_owner、elem_type_name
  my_constraints	pg_catalog、sys	owner、constraint_name、table_name、index_owner、index_name
  my_indexes	pg_catalog、sys	owner、index_name、table_name、table_owner、tablespace_name
  my_ind_columns	pg_catalog、sys	index_owner、index_name、table_name、table_owner、column_name
  my_objects	pg_catalog、sys	object_name、subobject_name
  my_procedures	pg_catalog、sys	owner、object_name、procedure_name、impltypeowner、impltypename
  my_role_privs	pg_catalog、sys	grantee、granted_role
  my_tab_col_statistics	pg_catalog、sys	table_name、column_name、schema
  my_source	pg_catalog、sys	owner、name
  my_tab_columns	pg_catalog、sys	owner、table_name、column_name、data_type_owner、schema
  my_tab_comments	pg_catalog、sys	owner、table_name、column_name、schema
  my_tab_statistics	pg_catalog、sys	table_name
  my_tables	pg_catalog、sys	owner、table_name、tablespace_name
  my_triggers	pg_catalog、sys	owner、trigger_name、table_owner、table_name
  my_type_attrs	pg_catalog、sys	type_name、attr_name、attr_type_name、character_set_name
  my_types	pg_catalog、sys	type_name
  my_views	pg_catalog、sys	owner、view_name
  pg_indexes	pg_catalog、sys	schemaname、tablename、indexname、tablespace
  pg_roles	pg_catalog、sys	rolename
  pg_tables	pg_catalog、sys	schemaname、tablename、tableowner、tablespace、tablecreator
  pg_user	pg_catalog、sys	username、nodegroup
  pg_views	pg_catalog、sys	schemaname、viewname、viewowner
  column_privileges	information_schema、sys	grantor、grantee、table_catalog、table_schema、table_name、column_name
  columns	information_schema、sys	table_catalog、table_schema、table_name、column_name
  constraint_column_usage	information_schema、sys	table_catalog、table_schema、table_name、column_name、constraint_catalog、constraint_schema、constraint_name
  constraint_table_usage	information_schema、sys	table_catalog、table_schema、table_name、constraint_catalog、constraint_schema、constraint_name
  enabled_roles	information_schema、sys	role_name
  schemata	information_schema、sys	catalog_name、schema_name、schema_owner、default_character_set_catalog、default_character_set_schema、default_character_set_name
  table_constraints	information_schema、sys	constraint_catalog、constraint_schema、constraint_name、table_catalog、table_schema、table_name
  table_privileges	information_schema、sys	grantor、grantee、table_catalog、table_schema、table_name
  tables	information_schema、sys	table_catalog、table_schema、table_name、self_referencing_column_name、user_defined_type_catalog、user_defined_type_schema、user_defined_type_name
  triggers	information_schema、sys	trigger_catalog、trigger_schema、trigger_name、event_object_catalog、event_object_schema、event_object_table、action_reference_old_table、action_reference_new_table
  usage_privileges	information_schema、sys	grantor、grantee、object_catalog、object_schema、object_name
  views	information_schema、sys	table_catalog、table_schema、table_name

  表3 支持审核的SQL语法

  DDL类型	SQL语法
  DROP	DROP TABLE, DROP TABLESPACE, DROP AGGREGATE, DROP AUDIT POLICY, DROP CAST, DROP DATABASE, DROP DATA SOURCE, DROP DIRECTORY, DROP EVENT, DROP FOREIGN TABLE, DROP GLOBAL CONFIGURATION, DROP GROUP, DROP MASKING POLICY, DROP MATERIALIZED VIEW, DROP MODEL, DROP OPERATOR, DROP OWNED, DROP PACKAGE, DROP PACKAGE BODY, DROP PROCEDURE, DROP RESOURCE LABEL, DROP RESOURCE POOL, DROP ROLE, DROP ROW LEVEL SECURITY POLICY, DROP RULE, DROP PUBLICATION, DROP SCHEMA, DROP SEQUENCE, DROP FUNCTION, DROP SERVER, DROP SUBSCRIPTION, DROP SYNONYM, DROP TEXT SEARCH CONFIGURATION, DROP TEXT SEARCH DICTIONARY, DROP TRIGGER, DROP TYPE, DROP USER, DROP USER MAPPING, DROP VIEW, DROP WEAK PASSWORD DICTIONARY
  ALTER	ALTER DROP PARTITION, ALTER TRUNCATE PARTITION, ALTER DROP COLUMN, ALTER DROP CONSTRAINT, ALTER DROP FOREIGN TABLE, ALTER DROP AUDIT POLICY, ALTER DROP MASKING POLICY, ALTER DROP SERVER, ALTER DROP TEXT SEARCH CONFIGURATION, ALTER DROP USER MAPPING, ALTER DROP DATA SOURCE
  TRUNCATE	TRUNCATE

操作步骤

1. 登录UGO控制台。
2. 单击左侧导航栏“SQL审核 > 语句审核”，默认进入“审核文本”页面。
3. 在审核文本页面，完成信息的填写，“提交审核”按钮高亮显示。
   图1 审核文本
   

   表4 审核文本参数说明

   参数名称	说明
   数据库类型	下拉选择数据库类型。当前仅支持GaussDB和MySQL数据库。
   数据源信息	下拉选择数据源，当前仅支持GaussDB和MySQL。 非必选，若不提供数据源，默认跳过依赖数据源的审核规则。
   schema信息	下拉选择数据源中的schema名称。非必选且仅支持GaussDB数据库。 SQL语句中有schema名称，使用SQL语句中的schema。 SQL语句中没有schema名称，使用选择的schema。 SQL语句中没有schema名称，并且没有选择schema，默认使用public。
   规则模板	依据所选的数据库类型，下拉选择对应的模板。 具体模板信息可在新增规则模板中设置。
   SQL语句	输入需要进行审核的SQL语句。 文本审核仅支持单语句审核。即使出现多个语句，也只会审核第一条语句。 若输入大写的SQL对象名称且没有用双引号引起来，系统会自动转换为小写，然后再从数据库中查对应的表结构。

4. 单击“提交审核”，会弹出“审核详情”并在历史记录中生成一条对应的记录。
   图2 审核详情
   

   单击“规则模板”后的模板名称，可跳转到具体的模板信息。

   若语句审核失败时，显示分析原因。

   失败原因（示例）：

   • line:1, position:14, token:table：表示SQL语句中存在关键字“table”。
   • line:1, position:3, token:<EOF>：表示输入SQL语句不完整。