pg_store_plans

概览

版本

构建

您可以使用 pig build 命令构建 pg_store_plans 扩展的 RPM / DEB 包：

pig build pkg pg_store_plans         # 构建 RPM / DEB 包

安装

您可以直接安装 pg_store_plans 扩展包的预置二进制包，首先确保 PGDG 和 PIGSTY 仓库已经添加并启用：

pig repo add pgsql -u          # 添加仓库并更新缓存

使用 pig 或者是 apt/yum/dnf 安装扩展：

• 安装
• pig
• dnf
• apt

pig install pg_store_plans;          # 当前活跃 PG 版本安装

pig ext install -y pg_store_plans -v 18  # PG 18
pig ext install -y pg_store_plans -v 17  # PG 17
pig ext install -y pg_store_plans -v 16  # PG 16
pig ext install -y pg_store_plans -v 15  # PG 15
pig ext install -y pg_store_plans -v 14  # PG 14

dnf install -y pg_store_plans_18       # PG 18
dnf install -y pg_store_plans_17       # PG 17
dnf install -y pg_store_plans_16       # PG 16
dnf install -y pg_store_plans_15       # PG 15
dnf install -y pg_store_plans_14       # PG 14

apt install -y postgresql-18-pg-store-plan   # PG 18
apt install -y postgresql-17-pg-store-plan   # PG 17
apt install -y postgresql-16-pg-store-plan   # PG 16
apt install -y postgresql-15-pg-store-plan   # PG 15
apt install -y postgresql-14-pg-store-plan   # PG 14

预加载配置：

shared_preload_libraries = 'pg_store_plans';

创建扩展：

CREATE EXTENSION pg_store_plans;

用法

来源：official docs，repo，1.10 release notes

pg_store_plans 用于跟踪 SQL 语句的执行计划统计信息，作用类似于 pg_stat_statements 对语句统计的补充。上游 1.10 发布说明指出该版本新增 PostgreSQL 18 支持，其余 SQL 接口与当前文档保持一致。

必要服务器设置

shared_preload_libraries = 'pg_store_plans'
compute_query_id = 'on'

pg_store_plans 需要共享内存，因此增删该扩展都需要重启。文档还说明如果 compute_query_id = 'no'，模块会被静默禁用。

查看已存储计划

SELECT queryid, planid, plan, calls, total_time, rows
FROM pg_store_plans
ORDER BY total_time DESC;

SELECT * FROM pg_store_plans_info;

文档将 queryid 作为与 pg_stat_statements 的关联键，并将 pg_store_plans_info 描述为单行视图，用于暴露 dealloc、stats_reset 等模块级统计。

辅助函数

SELECT pg_store_plans_reset();
SELECT pg_store_hash_query('SELECT 1');
SELECT pg_store_plans_textplan(plan);
SELECT pg_store_plans_jsonplan(plan);
SELECT pg_store_plans_xmlplan(plan);
SELECT pg_store_plans_yamlplan(plan);

当 pg_store_plans.plan_format = 'raw' 时，pg_store_plans_*plan() 尤其实用。

关键 GUC

• pg_store_plans.max
• pg_store_plans.track
• pg_store_plans.max_plan_length
• pg_store_plans.plan_storage
• pg_store_plans.plan_format
• pg_store_plans.min_duration
• pg_store_plans.log_analyze
• pg_store_plans.log_buffers
• pg_store_plans.log_timing
• pg_store_plans.save

文档说明 plan_storage 取值为 file 或 shmem，plan_format 取值为 text、json、xml、yaml 或 raw。

注意事项

• 非超级用户不能查看其他用户执行语句对应的 plan、queryid 或 planid。
• pg_store_plans 与 pg_stat_statements 独立维护条目，因此低频记录不一定总能在另一侧找到对应行。