支持SQL PATCH

可获得性

本特性自openGauss 3.1.0版本开始引入。

特性简介

SQL PATCH能够在避免直接修改用户业务语句的前提下对查询执行的方式做一定调整。在发现查询语句的执行计划、执行方式未达预期的场景下，可以通过创建查询补丁的方式，使用Hint对查询计划进行调优或对特定的语句进行报错短路处理。

客户价值

在业务产生查询计划不优导致的性能问题或系统内部错误导致服务不可用问题时，可以在数据库内通过运维函数调用对特定的场景进行调优或提前报错，以规避更严重的问题，能够大幅降低上述问题的运维成本。

特性描述

SQL PATCH主要设计给DBA、运维人员及其他需要对SQL进行调优的角色使用，用户通过其他运维视图或定位手段识别到业务语句存在计划不优导致的性能问题时，可以通过创建SQL PATCH对业务语句进行基于Hint的调优。目前支持行数、扫描方式、连接方式、连接顺序、PBE custom/generic计划选择、语句级参数设置、参数化路径的Hint。此外，对于部分由特定语句触发系统内部问题导致系统可服务性受损的语句，在不对业务语句变更的情况下，也可以通过创建用于单点规避的SQL PATCH，对问题场景提前报错处理，避免更大的损失。

SQL PATCH的实现当前基于Unique SQL ID，所以需要打开相关的运维参数才可以生效（详见特性约束），Unique SQL ID在WDR报告和慢SQL视图中都可以获取到，在创建SQL PATCH时需要指定Unique SQL ID。下面给出简单的使用样例。

场景一：使用SQL PATCH对特定语句进行Hint调优。

openGauss=# CREATE TABLE hint_t1 (a int, b int, c int);
CREATE TABLE
openGauss=# CREATE UNIQUE INDEX t1 ON hint_t1(a);
CREATE INDEX
openGauss=# CREATE OR REPLACE FUNCTION batch_insert()
openGauss-# RETURNS int AS $$
openGauss$# DECLARE
openGauss$# i INT;
openGauss$# start INT;
openGauss$#     row_count INT := 1000;
openGauss$# BEGIN
openGauss$# SELECT COUNT(*) INTO start FROM hint_t1;
openGauss$#     FOR i IN SELECT generate_series(1, row_count) LOOP
openGauss$#         INSERT INTO hint_t1 VALUES (start + i, start + i, start + i);
openGauss$#     END LOOP;
openGauss$#
openGauss$# RETURN row_count;
openGauss$# END;
openGauss$# $$ LANGUAGE plpgsql;

select batch_insert();
CREATE FUNCTION
openGauss=#
openGauss=# select batch_insert();
 batch_insert
--------------
         1000
(1 row)

openGauss=# set track_stmt_stat_level = 'L1,L1'; --打开FullSQL统计信息
SET
openGauss=# select * from hint_t1 where a in (10, 20, 30, 40, 50, 60, 70, 80, 90, 100);
  a  |  b  |  c
-----+-----+-----
  10 |  10 |  10
  20 |  20 |  20
  30 |  30 |  30
  40 |  40 |  40
  50 |  50 |  50
  60 |  60 |  60
  70 |  70 |  70
  80 |  80 |  80
  90 |  90 |  90
 100 | 100 | 100
(10 rows)

openGauss=# \x
Expanded display is on.
openGauss=# select unique_query_id, query, query_plan from dbe_perf.statement_history where query like '%hint_t1%';
-[ RECORD 1 ]---+------------------------------------------------------------------
unique_query_id | 1432981246
query           | select * from hint_t1 where a in (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);
query_plan      | Datanode Name: db1
                | Bitmap Heap Scan on hint_t1  (cost=22.59..33.24 rows=10 width=12)
                |   Recheck Cond: (a = ANY ('***'::integer[]))
                |   ->  Bitmap Index Scan on t1  (cost=0.00..22.59 rows=10 width=0)
                |         Index Cond: (a = ANY ('***'::integer[]))
                |
                |

openGauss=# select * from dbe_sql_util.create_hint_sql_patch('patch1', 1432981246, 'indexscan(hint_t1)'); -- 对指定的Unique SQL ID指定Hint Patch
-[ RECORD 1 ]---------+--
create_hint_sql_patch | t

openGauss=# \x
Expanded display is off.
openGauss=# explain select * from hint_t1 where a in (10, 20, 30, 40, 50, 60, 70, 80, 90, 100); -- 通过explain可以确认Hint是否生效
NOTICE:  Plan influenced by SQL hint patch
                               QUERY PLAN
-------------------------------------------------------------------------
 Index Scan using t1 on hint_t1  (cost=0.01..50.69 rows=10 width=12)
   Index Cond: (a = ANY ('{10,20,30,40,50,60,70,80,90,100}'::integer[]))
(2 rows)

openGauss=# select * from hint_t1 where a in (10, 20, 30, 40, 50, 60, 70, 80, 90, 100);
  a  |  b  |  c
-----+-----+-----
  10 |  10 |  10
  20 |  20 |  20
  30 |  30 |  30
  40 |  40 |  40
  50 |  50 |  50
  60 |  60 |  60
  70 |  70 |  70
  80 |  80 |  80
  90 |  90 |  90
 100 | 100 | 100
(10 rows)

openGauss=# \x
Expanded display is on.
openGauss=# select unique_query_id, query, query_plan from dbe_perf.statement_history where query like '%hint_t1%'; -- 可以看到新的执行计划已经改变了
-[ RECORD 1 ]---+--------------------------------------------------------------------
unique_query_id | 1432981246
query           | select * from hint_t1 where a in (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);
query_plan      | Datanode Name: db1
                | Bitmap Heap Scan on hint_t1  (cost=22.59..33.24 rows=10 width=12)
                |   Recheck Cond: (a = ANY ('***'::integer[]))
                |   ->  Bitmap Index Scan on t1  (cost=0.00..22.59 rows=10 width=0)
                |         Index Cond: (a = ANY ('***'::integer[]))
                |
                |
-[ RECORD 2 ]---+--------------------------------------------------------------------
unique_query_id | 1432981246
query           | select * from hint_t1 where a in (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);
query_plan      | Datanode Name: db1
                | Index Scan using t1 on hint_t1  (cost=0.01..50.69 rows=10 width=12)
                |   Index Cond: (a = ANY ('***'::integer[]))
                |
                |

场景二：使用SQL PATCH对特定语句进行提前报错规避。

openGauss=# select * from dbe_sql_util.drop_sql_patch('patch1'); -- 删去patch1
 drop_sql_patch
----------------
 t
(1 row)
openGauss=# select * from dbe_sql_util.create_abort_sql_patch('patch2', 2578396627); 对该语句的Unique SQL ID创建Abort Patch
 create_abort_sql_patch
------------------------
 t
(1 row)

openGauss=# select * from hint_t1 t1 where t1.a = 1; -- 再次执行语句会提前报错
ERROR:  Statement 2578396627 canceled by abort patch patch2

特性增强

无。

特性约束

仅支持针对Unique SQL ID打PATCH，如果存在Unique SQL ID冲突，用于Hint调优的SQL PATCH可能影响性能，但不影响语义正确性。
仅支持不改变SQL语义的Hint作为PATCH，不支持SQL改写。
不支持逻辑备份、恢复。
不支持创建时校验PATCH合法性，如果PATCH的Hint存在语法或语义错误，不影响查询正确执行。
仅初始用户、运维管理员、监控管理员、系统管理员用户有权限执行。
库之间不共享，创建SQL PATCH时需要连接目标库。
配置集中式备机可读时，需要指定主机执行SQL PATCH创建/修改/删除函数调用，备机执行报错。
SQL PATCH同步给备机存在一定延迟，待备机回放相关日志后PATCH生效。
不支持对存储过程中的SQL语句生效，当前机制不会对存储过程内语句生成Unique SQL ID。
用于规避的Abort Patch不建议在数据库中长期使用，只应该作为临时规避方法。遇到内核问题所导致的特定语句触发数据库服务不可用问题，需要尽快修改业务或升级内核版本解决问题。并且升级后由于Unique SQL ID生成方法可能变化，可能导致规避方法失效。
当前，除DML语句之外，其他SQL语句（如CREATE TABLE等）的Unique SQL ID是对语句文本直接哈希生成的，所以对于此类语句，SQL PATCH对大小写、空格、换行等敏感，即不同的文本的语句，即使语义相对，仍然需要对应不同的SQL PATCH。对于DML，则同一个SQL PATCH可以对不同入参的语句生效，并且忽略大小写和空格。

依赖关系

本特性依赖于资源实时监控功能，需要开启enable_resource_track参数并且设置instr_unique_sql_count大于0。对于不同的语句，如果生成的Unique SQL ID冲突，会导致SQL PATCH错误的命中预期外的其他语句。其中用于调优的Hint PATCH副作用相对较小，Abort Patch需要谨慎使用。