
# EXPLAIN PLAN
#### 功能描述
通过EXPLAIN PLAN命令可以将查询执行的计划信息存储于PLAN_TABLE表中。与EXPLAIN命令不同的是，EXPLAIN PLAN仅将计划信息进行存储，而不会打印到屏幕。
#### 语法格式
```
EXPLAIN PLAN
[ SET STATEMENT_ID = name ]
FOR statement ;
```
#### 参数说明
- **name**
  查询标签。
  取值范围：字符串
  

- EXPLAIN中的PLAN选项表示需要将计划信息存储于PLAN_TABLE中，存储成功将返回"EXPLAIN SUCCESS"。
- STATEMENT_ID用户可以对查询设置标签，输入的标签信息也将存储于PLAN_TABLE中。
  ![](https://support.huaweicloud.com/centralized-devg-v2-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
  用户在执行EXPLAIN PLAN时，如果没有进行SET STATEMENT_ID，则默认为空值。同时，用户可输入的STATEMENT_ID最大长度为30个字节，超过长度将会产生报错。
  
 
#### 注意事项
- EXPLAIN PLAN不支持在数据库节点上执行。
- 对于执行错误的SQL无法进行计划信息的收集。
- PLAN_TABLE中的数据是session级生命周期并且session隔离和用户隔离，用户只能看到当前session、当前用户的数据。
 
#### 示例 1
使用EXPLAIN PLAN收集SQL语句的执行计划，通常包括以下步骤：
1. 执行EXPLAIN PLAN。 
   ![](https://support.huaweicloud.com/centralized-devg-v2-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
   执行EXPLAIN PLAN 后会将计划信息自动存储于PLAN_TABLE中，不支持对PLAN_TABLE进行INSERT、UPDATE、ANALYZE等操作。
   PLAN_TABLE详细介绍见[PLAN_TABLE](https://support.huaweicloud.com/centralized-devg-v2-gaussdb/gaussdb_42_0895.html#ZH-CN_TOPIC_0000002186016954)。
   ```
   --创建表foo1,foo2。
   openGauss=# CREATE TABLE foo1(f1 int, f2 text, f3 text[]);
   openGauss=# CREATE TABLE foo2(f1 int, f2 text, f3 text[]);
   --执行explain plan。
   openGauss=# EXPLAIN PLAN SET STATEMENT_ID = 'TPCH-Q4' FOR SELECT f1, count(*) FROM foo1 WHERE f1 > 1 AND f1 < 3 AND EXISTS (SELECT * FROM foo2) GROUP BY f1;
   ```
   
   
2. 查询PLAN_TABLE。 
   ```
   openGauss=# SELECT * FROM plan_table;
   ```
   
   
3. 清理PLAN_TABLE表中的数据。 
   ```
   openGauss=# DELETE FROM plan_table WHERE STATEMENT_ID = 'TPCH-Q4';
   openGauss=# DROP TABLE foo1;
   openGauss=# DROP TABLE foo2;
   ```
   
   
 
