# restore_command

> restore_command：设置取回归档 WAL 文件时调用的 shell 命令。它是 PG12–18 的 sighup 参数；最新实测启动默认值为 empty。
---

> [!NOTE]
> **Fact — 官方简述译文**：设置取回归档 WAL 文件时调用的 shell 命令。

## 身份 {#identity}

| 字段 | 值 | 含义 |
| --- | --- | --- |
| 类型 | `string` | 上游 pg_settings 类型 |
| Context | `sighup` | 配置 reload 后生效 |
| 单位 | — | 原始单位 |
| 范围 | — | 最后在档版本的原始上下限 |
| 枚举值 | — | 非枚举类型记为 — |
| 分类 | Write-Ahead Log / Archive Recovery | 上游分类 |
| 最后 boot 值 | `""` | empty string |
{.fields meta="-"}

## 生命周期 {#lifecycle}

| Fact | 值 |
| --- | --- |
| 首次观测 | PG12 |
| 在档版本 | PG12–19 Beta 3 |
| 移除版本 | 否 |
| 引入提交 | [`2dedf4d9a899`](https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=2dedf4d9a899b36d1a8ed29be5efbd1b31a8fe85) — Integrate recovery.conf into postgresql.conf |
| 提交日期 | 2018-11-25 |
| Discussion | [讨论 1](https://www.postgresql.org/message-id/flat/607741529606767@web3g.yandex.ru/) |

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

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

## 机制详解 {#mechanism}

设置取回归档 WAL 文件时调用的 shell 命令。重新加载配置即可应用新值；已经开始的工作不会被追溯改变。

归档恢复时 PostgreSQL 把 %f 展开为请求文件、%p 展开为目标路径。成功必须表示准确文件已可靠复制；正常的未找到应返回非零，以便继续尝试流复制或 pg_wal，同时 shell 引用必须安全。

应把 restore_command 与 archive_mode、archive_command、archive_library 一起监控和变更。先在对应角色与真实负载上验证，再按其 sighup context 选择会话修改、reload 或 restart；历史默认值并不等于当前有效值。

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

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

| 场景 | 建议 |
| --- | --- |
| OLTP | 把 restore_command 作为备份/恢复协议的一部分管理：命令或模块必须幂等、失败可见，并通过从真实归档恢复来验证，而不是只看返回码。 |
| OLAP | 按批量装载 WAL 峰值配置归档吞吐与容量；归档跟不上时节流任务并报警，不能用虚假成功或激进清理掩盖积压。 |
| 小规格 | 有明确 PITR 需求才启用并交给成熟备份工具；可重建实例保持简单，但不要留下占位命令制造“已备份”的错觉。 |
{.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: PG12–19 Beta 3 未修改；OLAP: PG12–19 Beta 3 未修改；CRIT: PG12–19 Beta 3 未修改；TINY: PG12–19 Beta 3 未修改。 未发现覆盖值，因此不推断 Pigsty 专属理由。

## 常见坑 {#common-pitfalls}

- 缺失或错误 WAL 文件也返回零。
- 没有安全引用 %f 与 %p。
- 归档可能返回另一时间线或集群的同名段。
- 混淆 pg_settings 的原始单位与配置文件可读单位。
- 只做吞吐基准，不做崩溃恢复与归档还原。

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

[`archive_mode`](/zh/parameters/archive-mode/) · [`archive_command`](/zh/parameters/archive-command/) · [`archive_library`](/zh/parameters/archive-library/) · [`archive_timeout`](/zh/parameters/archive-timeout/) · [`archive_cleanup_command`](/zh/parameters/archive-cleanup-command/) · [`recovery_end_command`](/zh/parameters/recovery-end-command/)

## 参考资料 {#references}

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