执行计划缓存 
===========================

执行计划缓存（Plan Cache）用于减少执行计划的生成次数。

OceanBase 数据库会缓存之前生成的执行计划，以便在下次执行该 SQL 时直接使用，可以避免反复执行，从而优化执行过程，这种策略被称为"Optimize Once"，即"一次优化"。

计划缓存是一个典型的 Key-Value 结构，Key 就是参数化后的 SQL 字符串，Value 就是该条 SQL 所对应的执行计划。

每个租户在每一台服务器上都有一个独立的计划缓存，用以缓存在此服务器上处理过的 SQL 计划。在 OceanBase 数据库的计划缓存中，SQL 的执行计划可以分为本地计划、远程计划和分布式计划三种类型。在计划缓存中，同一条 SQL 根据其需要访问的数据不同，可能同时具有三种执行计划。

对于一条 SQL 的一种执行计划，OceanBase 数据库默认只会保留第一次执行 SQL 时生成的计划；但在某些情况下，同一条 SQL 的参数值可能会影响到执行计划的选择，所以计划缓存会根据需要，为不同的参数值保留不同的执行计划，从而保证每次执行时可以使用最合适的计划。

计划缓存的淘汰 
----------------

计划缓存的淘汰是指将执行计划从计划缓存中删除，减少计划缓存对内存的使用。OceanBase 数据库支持自动淘汰和手动淘汰两种方式。

#### **自动淘汰** 

自动淘汰是指当计划缓存占用的内存达到了需要淘汰计划的内存上限（即淘汰计划的高水位线）时，对计划缓存中的计划执行自动淘汰。

* 触发执行计划淘汰的条件

  每隔一段时间（具体时间间隔由配置项 `plan_cache_evict_interval` 设置）系统会自动检查不同租户在不同服务器上的计划缓存，并判断是否需要执行计划淘汰。如果某个计划缓存占用的内存超过该租户设置的淘汰计划的高水位线，则会触发计划缓存淘汰。
  




<!-- -->

* 执行计划淘汰策略

  当触发计划缓存淘汰后，优先淘汰最久没被使用的执行计划，淘汰一部分执行计划后，当计划缓存使用的内存为该租户设置的淘汰计划的低水位线时，停止淘汰。
  




<!-- -->

* 与计划缓存淘汰相关配置

  




<!-- -->



例如，租户内存大小为 10 G，各参数值设置如下：

* `ob_plan_cache_percentage`＝10

  

* `ob_plan_cache_evict_high_percentage`＝90

  

* `ob_plan_cache_evict_low_percentage`＝50

  




则计算得出：

* 计划缓存内存上限绝对值 ＝ 10G \* 10 / 100 = 1 G

  

* 淘汰计划的高水位线 = 1G \* 90 / 100 = 0.9 G

  

* 淘汰计划的低水位线 ＝ 1G \* 50 / 100 = 0.5 G

  




由计算结果可知，当该租户在某个服务器上计划缓存使用超过 0.9 G 时，会触发淘汰，优先淘汰最久没执行的计划，当淘汰到使用内存只有 0.5 G 时，则停止淘汰。 如果淘汰速度没有新计划生成速度快，计划缓存使用内存达到内存上限绝对值 1 G 时，将不在往计划缓存中添加新计划，直到执行淘汰后所占内存小于 1 G 才会添加新计划到计划缓存中。

#### **手动淘汰** 

手动淘汰是指强制将计划缓存中计划进行删除。现在支持指定不同租户对应的当前服务器或全部服务器中计划缓存全部删除，具体命令如下：

```javascript
obclient>ALTER SYSTEM FLUSH PLAN CACHE [tenant_list] [global] 
/*其中 tenant_list 的格式为 tenant = 'tenant1, tenant2, tenant3....'*/
```



其中 `tenant_list` 和 `global` 为可选字段，使用说明如下： 

* 如果没有指定 `tenant_list`，则清空所有租户的计划缓存。反之，则只清空特定租户的计划缓存。

  

* 如果没有指定 `global`，则清空本机的计划缓存。反之，则清空该租户所在的所有服务器上的计划缓存。

  






计划缓存的刷新 
----------------

计划缓存中执行计划可能因为各种原因而失效，这时需要将计划缓存中失效计划进行刷新，即将该执行计划删除后重新优化生成计划再加入计划缓存。

如下场景会导致执行计划失效，需要对执行计划进行刷新：

* SQL 中涉及表的 Schema 变更时（比如添加索引、删除或增加列等），该 SQL 在计划缓存中所对应的执行计划将被刷新。

  




<!-- -->

* SQL 中涉及重新收集表的统计信息时，该 SQL 在计划缓存中所对应的执行计划会被刷新。由于 OceanBase 数据库在数据合并时会统一进行统计信息的收集，因此在每次进行合并后，计划缓存中所有计划将被刷新。

  






计划缓存的使用控制 
------------------

计划缓存可以使用系统变量及 Hint 实现使用控制。

* 系统变量控制

  当 `ob_enable_plan_cache` 设置为 `TURE` 时，表示 SQL 请求可以使用计划缓存；设置为 `FALSE` 时，表示 SQL 请求不使用计划缓存。默认为 `TURE`。此系统变量可被设置为 Session 级别或者 Global 级别。
  

* Hint 控制

  




<!-- -->



计划缓存暂不支持的场景 
--------------------

* 执行计划所占内存超过 20 M 时，不会加入计划缓存。

  

* 如果该计划为分布式执行计划且涉及多个表，不会加入计划缓存。

  




计划缓存的视图 
----------------

执行计划相关视图包括：

* `(g)v$plan_cache_stat`

  记录每个计划缓存的状态，每个计划缓存在该视图中有一条记录。
  

* `(g)v$plan_cache_plan_stat`

  记录计划缓存中所有执行计划的具体信息及每个计划总的执行统计信息。
  

* `(g)v$plan_cache_plan_explain`

  记录某条 SQL 在计划缓存中的执行计划。
  




有关视图的详细参数信息，请参考 [计划缓存相关视图](../../../12.sql-optimization-guide-1/4.sql-optimization-1/3.monitor-sql-execution-performance-1/3.plan-cache-view.md)。
