# debug_pretty_print

> debug_pretty_print 是 PostgreSQL 中用于对解析树和计划树的显示进行缩进美化的参数。
---

> [!NOTE]
> **Fact — 官方简述译文**：对解析树和计划树的显示进行缩进美化。

## 身份 {#identity}

| 字段 | 值 | 含义 |
| --- | --- | --- |
| 类型 | `bool` | 上游 pg_settings 类型 |
| Context | `user` | 普通用户可在运行时修改 |
| 单位 | — | 原始单位 |
| 范围 | — | 最后在档版本的原始上下限 |
| 枚举值 | — | 非枚举类型记为 — |
| 分类 | Reporting and Logging / What to Log | 上游分类 |
| 最后 boot 值 | `on` | on |
{.fields meta="-"}

## 生命周期 {#lifecycle}

| Fact | 值 |
| --- | --- |
| 首次观测 | PG9.0（研究下界） |
| 在档版本 | PG9.0–19 Beta 3 |
| 移除版本 | 否 |
| 引入提交 | 不作断言：早于 PG9.0 研究边界 |
| 提交日期 | — |
| Discussion | — |

## 默认值变迁 {#default-history}

| 版本 | 原始 `boot_val` | 单位 | 人类可读值 |
| --- | --- | --- | --- |
| PG9.0–19 Beta 3 | `on` | — | on |
{.full-width caption="PG9.0–19 Beta 3 实测 boot 默认值"}

## 机制详解 {#mechanism}

debug_pretty_print：对解析树和计划树的显示进行缩进美化。它只改变 debug_print_* 开关所输出内部解析树与计划树的缩进格式。

debug_pretty_print 属于 USER 上下文。获授权角色可在会话内修改，ALTER ROLE 或 ALTER DATABASE 可为未来会话建立默认值。

debug_print_* 开关沿普通服务器日志路径输出，因此 log_min_messages、log_destination 与收集器容量共同决定内容能否安全保留。

## 调优建议 {#tuning-advice}

> [!TIP]
> **Advice。** 以下建议是工作负载起点，必须用真实测量验证。

| 场景 | 建议 |
| --- | --- |
| OLTP | 不应在生产环境全局调优或启用 debug_pretty_print。若服务器开发级诊断确有需要，只在单一会话短时开启，并安全接收产生的日志。 |
| OLAP | 不要用 debug_pretty_print 替代分析 SQL 的 EXPLAIN；应定向抓取计划，而不是转储每一棵内部树。 |
| 小规格 | 保持 debug_pretty_print 的正常默认值。冗长内部树可能意外耗尽小节点的日志 I/O 与磁盘。 |
{.full-width}

## Pigsty 取值 {#pigsty}

以下值来自固定 8 核、32 GiB、100 GiB SSD 夹具，并按 PG19 Beta 3 渲染当前 Pigsty 模板；这不表示 Pigsty 当前支持该历史或测试版本。

| 模板 | 有效值 | 与上游 boot 比较 | 源表达式 |
| --- | --- | --- | --- |
| OLTP | 未修改 | — | — |
| OLAP | 未修改 | — | — |
| CRIT | 未修改 | — | — |
| TINY | 未修改 | — | — |
{.full-width}

> [!CAUTION]
> **Advice — 待人工复核。** 当前 Pigsty 模板投影事实：OLTP: PG9.0–19 Beta 3 未修改；OLAP: PG9.0–19 Beta 3 未修改；CRIT: PG9.0–19 Beta 3 未修改；TINY: PG9.0–19 Beta 3 未修改。 未发现覆盖值，因此不推断 Pigsty 专属理由。

## 常见坑 {#common-pitfalls}

- 只在一个会话中修改 debug_pretty_print，却认为角色默认值、数据库默认值或其他池化会话也已随之改变。
- 全局长期打开内部树转储，压垮日志 I/O、存储或摄取。
- 把调试输出当作稳定公共格式，或用它替代定向 EXPLAIN 诊断。
- 没有回滚计划及客户端或运维兼容测试，就全局修改 debug_pretty_print。

## 关联参数 {#related-parameters}

[`debug_print_parse`](/zh/parameters/debug-print-parse/) · [`debug_print_plan`](/zh/parameters/debug-print-plan/) · [`debug_print_rewritten`](/zh/parameters/debug-print-rewritten/) · [`log_min_messages`](/zh/parameters/log-min-messages/) · [`client_min_messages`](/zh/parameters/client-min-messages/)

## 参考资料 {#references}

- [PostgreSQL 19 Beta 3 — debug_pretty_print](https://www.postgresql.org/docs/19/runtime-config-logging.html#GUC-DEBUG-PRETTY-PRINT)
- [PostgreSQL 19 发行说明](https://www.postgresql.org/docs/19/release-19.html)
- [机器可读 GUC 全量导出](/data/guc.jsonl)