参考 on PIG.CENTER

pgBadger 13.x 版本记录

Mon, 01 Jan 0001 00:00:00 +0000

本页按从新到旧的顺序保留 pgBadger 13.x 的完整上游变更记录。为确保版本、参数、提交者致谢和兼容性描述不被转述改变，正文保留英文原文。

v13.2 · 2025-12-29

This is a maintenance release of pgBadger that fixes issues and applied patches reported by users since last release.

注解命令（annotate）

Mon, 01 Jan 0001 00:00:00 +0000

backup 命令执行时附加的注解，可在事后通过 annotate 命令进行添加、修改或删除。

命令选项

备份注解选项（`--annotation`）

为备份添加用户自定义键值对注解。

动态配置

Mon, 01 Jan 0001 00:00:00 +0000

动态配置存储在 DCS（分布式配置存储）中，并应用于集群的所有节点。

如需修改动态配置，可使用 patronictl edit-config 工具或 Patroni REST API 。

loop_wait：主循环每轮的休眠秒数。默认值：10，最小值：1。
ttl：获取领导者锁的 TTL（秒）。可以理解为触发自动故障转移前的等待时长。默认值：30，最小值：20。
retry_timeout：DCS 和 PostgreSQL 操作的重试超时时间（秒）。若 DCS 或网络故障时长短于此值，Patroni 不会对主库执行降级。默认值：10，最小值：3。

警告

修改 loop_wait、retry_timeout 或 ttl 时，必须遵守以下约束：

新闻

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest 2.59.1 正式发布

2026 年 8 月 17 日

pgBackRest 社区很高兴地宣布 pgBackRest 2.59.1 正式发布。pgBackRest 是一款可靠、易用的备份与恢复解决方案，可无缝扩展以应对超大规模数据库和工作负载。

pgBadger 12.x 版本记录

Mon, 01 Jan 0001 00:00:00 +0000

本页按从新到旧的顺序保留 pgBadger 12.x 的完整上游变更记录。为确保版本、参数、提交者致谢和兼容性描述不被转述改变，正文保留英文原文。

v12.4 · 2023-12-25

This is a maintenance release of pgBadger that fixes issues reported by users since last release.

归档获取命令（archive-get）

Mon, 01 Jan 0001 00:00:00 +0000

PostgreSQL 通过此命令执行备份恢复、PITR，或将其作为流复制的替代方式来维持副本同步。WAL 段是 PostgreSQL 执行恢复或维护副本的必要条件。

配置多个仓库时，pgBackRest 按优先级顺序（如 repo1、repo2 等）依次从各仓库获取 WAL。速度更快或成本更低的存储应配置更高的优先级。若通过 --repo 选项指定了某个仓库，则仅从该仓库中查找。

YAML 配置参数

Mon, 01 Jan 0001 00:00:00 +0000

全局/通用

name：主机名称，在集群中必须唯一。
namespace：Patroni 在配置存储中保存集群信息的路径，默认值为 /service。
scope：集群名称。

配置：pgbouncer.ini

Mon, 01 Jan 0001 00:00:00 +0000

描述

配置文件采用 “ini” 格式。节名称位于 [ 和 ] 之间。以 ; 或 # 开头的行被视为注释并忽略。当 ; 和 # 出现在行中间时，不会被识别为特殊字符。

pgBadger 11.x 版本记录

Mon, 01 Jan 0001 00:00:00 +0000

本页按从新到旧的顺序保留 pgBadger 11.x 的完整上游变更记录。为确保版本、参数、提交者致谢和兼容性描述不被转述改变，正文保留英文原文。

v11.8 · 2022-04-08

This release of pgBadger fix some issues reported by users since past three months and especially two fixes on new log entries detection in incremental mode.

归档推送命令（archive-push）

Mon, 01 Jan 0001 00:00:00 +0000

接收来自 PostgreSQL 的 WAL 段，并将其归档到各个仓库中（仓库路径由带索引的 repo-path 选项定义，详见 仓库选项 章节）。WAL 段可以立即推送到归档，也可以根据 archive-async 的值先暂存在本地。配置了多个仓库时，archive-push 会尽量向所有仓库推送。

Patroni 配置

Mon, 01 Jan 0001 00:00:00 +0000

Patroni 的配置分为 3 种类型：

全局 动态配置 。这些选项存储在 DCS（分布式配置存储）中，并应用于集群的所有节点。动态配置可以随时通过 patronictl edit-config 工具或 Patroni REST API 进行设置。如果更改的选项不属于启动配置，它们将异步地（在下一个唤醒周期时）应用到每个节点，随后触发重载。如果节点需要重启才能应用配置（对于上下文为 postmaster 且值已更改的 PostgreSQL 参数），则会在成员数据 JSON 中设置一个特殊标志 pending_restart，同时节点状态也会通过 "restart_pending": true 来体现这一情况。

环境变量

Mon, 01 Jan 0001 00:00:00 +0000

可以使用系统环境变量覆盖 Patroni 配置文件中定义的部分配置参数。本文档列出了 Patroni 处理的所有环境变量。通过环境变量设置的值始终优先于配置文件中的值。

全局/通用

PATRONI_CONFIGURATION：可通过 PATRONI_CONFIGURATION 环境变量为 Patroni 提供完整配置。设置此变量后，其他所有环境变量将被忽略！
PATRONI_NAME：运行当前 Patroni 实例的节点名称，在集群内必须唯一。
PATRONI_NAMESPACE：Patroni 在配置存储中保存集群信息的路径。默认值："/service"。
PATRONI_SCOPE：集群名称。

日志

PATRONI_LOG_TYPE：日志格式，可为 plain 或 json。使用 json 格式需要安装 jsonlogger 。默认值为 plain。
PATRONI_LOG_LEVEL：全局日志级别。默认值为 INFO（参见 Python logging 文档）。
PATRONI_LOG_TRACEBACK_LEVEL：显示 traceback 的日志级别。默认值为 ERROR。若希望仅在 PATRONI_LOG_LEVEL=DEBUG 时才显示 traceback，可将其设置为 DEBUG。
PATRONI_LOG_FORMAT：日志格式化字符串。若日志类型为 plain，格式应为字符串，可用属性参见 LogRecord 属性文档。若日志类型为 json，格式除字符串外还可以是列表，每个列表项对应一个 LogRecord 属性，只需填写字段名，省略 %( 和 )。若希望以不同键名输出某个字段，可使用字典，键为日志字段名，值为希望在日志中显示的字段名。默认值为 %(asctime)s %(levelname)s: %(message)s。
PATRONI_LOG_DATEFORMAT：日期时间格式化字符串（参见 formatTime() 文档）。
PATRONI_LOG_STATIC_FIELDS：为日志添加额外字段，仅在日志类型为 json 时可用。示例：PATRONI_LOG_STATIC_FIELDS="{app: patroni}"。
PATRONI_LOG_MAX_QUEUE_SIZE：Patroni 采用两步日志记录机制。日志记录先写入内存队列，由独立线程从队列中取出后写入 stderr 或文件。内存队列容量默认限制为 1000 条，足以保留过去约 1 小时 20 分钟的日志。
PATRONI_LOG_DIR：应用程序日志的写入目录。该目录必须已存在且对运行 Patroni 的用户可写。设置此变量后，默认保留 4 个 25MB 的日志文件，可通过 PATRONI_LOG_FILE_NUM 和 PATRONI_LOG_FILE_SIZE 调整（见下文）。
PATRONI_LOG_MODE：日志文件权限（例如 0644）。若未指定，将基于当前 umask 值设置。
PATRONI_LOG_FILE_NUM：保留的应用程序日志文件数量。
PATRONI_LOG_FILE_SIZE：触发日志滚动的 patroni.log 文件大小（字节）。
PATRONI_LOG_LOGGERS：按 Python 模块重新定义日志级别。示例：PATRONI_LOG_LOGGERS="{patroni.postmaster: WARNING, urllib3: DEBUG}"。
PATRONI_LOG_DEDUPLICATE_HEARTBEAT_LOGS：设置为 true 时，连续且内容相同的心跳日志不再重复输出。默认值为 false。

警告

HA 循环的执行时间是诊断资源耗尽等问题所致故障转移的重要信息。将 PATRONI_LOG_DEDUPLICATE_HEARTBEAT_LOGS 设置为 true 后，HA 循环执行将不产生日志（除非领导者发生变化），导致这些潜在有用的信息无法从日志中获取。

命令行参考

Mon, 01 Jan 0001 00:00:00 +0000

本页保留固定上游源码生成的完整命令参考。为了能与 pgbadger --help 逐项核对，参数名、帮助文字和命令示例均保留英文原文。

用法与选项

Usage: pgbadger [options] logfile […]

pgBadger 10.x 版本记录

Mon, 01 Jan 0001 00:00:00 +0000

本页按从新到旧的顺序保留 pgBadger 10.x 的完整上游变更记录。为确保版本、参数、提交者致谢和兼容性描述不被转述改变，正文保留英文原文。

v10.3 · 2019-02-14

This release of pgBadger is a maintenance release that fixes some log format autodetection issues another pgBouncer log parsing issue reported by users. There is also a new feature:

备份命令（backup）

Mon, 01 Jan 0001 00:00:00 +0000

配置多个仓库时，pgBackRest 默认备份到优先级最高的仓库（如 repo1），除非通过 --repo 选项明确指定目标仓库。

pgBackRest 本身不内置调度器，建议通过 cron 或其他调度机制触发备份。

Patroni REST API

Mon, 01 Jan 0001 00:00:00 +0000

Patroni 提供了丰富的 REST API，供 Patroni 自身在主库竞选期间调用，也供 patronictl 工具执行故障转移、主从切换、重新初始化、重启和重载等操作，还可供 HAProxy 或其他负载均衡器执行 HTTP 健康检查，以及用于监控目的。以下是 Patroni REST API 端点的完整列表。

命令参考

Mon, 01 Jan 0001 00:00:00 +0000

简介

pgBackRest 通过命令来执行各项功能。本文档对每个命令的选项进行了详尽列举——即每个适用于某命令的选项都会随该命令一并列出，即便该选项同样适用于其他命令。所有可在 pgbackrest.conf 中配置的选项均包含在内。

pgBadger 9.x 版本记录

Mon, 01 Jan 0001 00:00:00 +0000

本页按从新到旧的顺序保留 pgBadger 9.x 的完整上游变更记录。为确保版本、参数、提交者致谢和兼容性描述不被转述改变，正文保留英文原文。

v9.2 · 2017-07-27

This release of pgBadger is a maintenance release that adds some new features.

检查命令（check）

Mon, 01 Jan 0001 00:00:00 +0000

check 命令用于验证 pgBackRest 及 archive_command 的配置是否正确，确保指定 stanza（stanza 是 pgBackRest 中用于标识 PostgreSQL 集群备份配置的逻辑名称）的归档与备份能够正常运作。该命令会对当前主机上为该 stanza 配置的所有仓库和数据库逐一检查，可检测出配置错误——尤其是归档配置问题，此类问题会导致所需的 WAL 段无法进入归档，从而造成备份不完整。此命令可在 PostgreSQL 主机或仓库主机上运行；也可在备库主机上运行，但由于备库无法执行 pg_switch_xlog()/pg_switch_wal()，命令仅会测试仓库配置。

HAProxy 3.4.4 中文文档

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy 是一款免费、快速、可靠的反向代理，适用于高可用、TCP 与 HTTP 负载均衡及应用流量管理。本组件收录三套 HAProxy 3.4 核心手册的完整中文译文，并将其重新编排为适合 OINK 阅读器的扁平阅读顺序。

patronictl 命令行

Mon, 01 Jan 0001 00:00:00 +0000

Patroni 提供了 patronictl 命令行工具，用于与 Patroni 的 REST API 和 DCS 交互，旨在简化集群操作，适合人工操作或脚本调用。

配置

patronictl 使用以下 3 个配置节：

配置参考

Mon, 01 Jan 0001 00:00:00 +0000

简介

pgBackRest 可以完全通过命令行参数使用，但当配置较为复杂或需要设置大量选项时，使用配置文件更为实用。配置文件的默认路径为 /etc/pgbackrest/pgbackrest.conf。若该路径下不存在配置文件，则会检查旧的默认路径 /etc/pgbackrest.conf。

源码发布版下载

Mon, 01 Jan 0001 00:00:00 +0000

PgBouncer 1.25

File	Date	Size	SHA256
pgbouncer-1.25.2.tar.gz	2026-05-08	865371 bytes	sha256
pgbouncer-1.25.1.tar.gz	2025-12-03	864801 bytes	sha256
pgbouncer-1.25.0.tar.gz	2025-11-09	863322 bytes	sha256

PgBouncer 1.24

File	Date	Size	SHA256
pgbouncer-1.24.1.tar.gz	2025-04-16	717796 bytes	sha256
pgbouncer-1.24.0.tar.gz	2025-01-10	706573 bytes	sha256

PgBouncer 1.23

File	Date	Size	SHA256
pgbouncer-1.23.1.tar.gz	2024-08-02	700025 bytes	sha256
pgbouncer-1.23.0.tar.gz	2024-07-03	694845 bytes	sha256

PgBouncer 1.22

File	Date	Size	SHA256
pgbouncer-1.22.1.tar.gz	2024-03-04	677351 bytes	sha256
pgbouncer-1.22.0.tar.gz	2024-01-31	670589 bytes	sha256

PgBouncer 1.21

File	Date	Size	SHA256
pgbouncer-1.21.0.tar.gz	2023-10-16	668211 bytes	sha256

PgBouncer 1.20

File	Date	Size	SHA256
pgbouncer-1.20.1.tar.gz	2023-08-09	638844 bytes	sha256
pgbouncer-1.20.0.tar.gz	2023-07-20	638020 bytes	sha256

PgBouncer 1.19

File	Date	Size	SHA256
pgbouncer-1.19.1.tar.gz	2023-05-31	623569 bytes	sha256
pgbouncer-1.19.0.tar.gz	2023-05-04	616947 bytes	sha256

PgBouncer 1.18

File	Date	Size	SHA256
pgbouncer-1.18.0.tar.gz	2022-12-12	600825 bytes	sha256

PgBouncer 1.17

File	Date	Size	SHA256
pgbouncer-1.17.0.tar.gz	2022-03-23	598294 bytes	sha256

PgBouncer 1.16

File	Date	Size	SHA256
pgbouncer-1.16.1.tar.gz	2021-11-11	591450 bytes	sha256
pgbouncer-1.16.0.tar.gz	2021-08-09	592136 bytes	sha256

PgBouncer 1.15

File	Date	Size	SHA256
pgbouncer-1.15.0.tar.gz	2020-11-19	588042 bytes	sha256

PgBouncer 1.14

File	Date	Size	SHA256
pgbouncer-1.14.0.tar.gz	2020-06-11	578955 bytes	sha256

PgBouncer 1.13

File	Date	Size	SHA256
pgbouncer-1.13.0.tar.gz	2020-04-27	574955 bytes	sha256

PgBouncer 1.12

File	Date	Size	SHA256
pgbouncer-1.12.0.tar.gz	2019-10-17	567465 bytes	sha256

PgBouncer 1.11

File	Date	Size	SHA256
pgbouncer-1.11.0.tar.gz	2019-08-27	571414 bytes	sha256

PgBouncer 1.10

File	Date	Size	SHA256
pgbouncer-1.10.0.tar.gz	2019-07-01	480571 bytes	sha256

PgBouncer 1.9

File	Date	Size	SHA256
pgbouncer-1.9.0.tar.gz	2018-08-13	469300 bytes	sha256

PgBouncer 1.8

File	Date	Size	SHA256
pgbouncer-1.8.1.tar.gz	2017-12-20	465930 bytes	sha256
pgbouncer-1.8.tar.gz	2017-12-19	465612 bytes	sha256

PgBouncer 1.7

File	Date	Size	SHA256
pgbouncer-1.7.2.tar.gz	2016-02-26	462374 bytes	sha256
pgbouncer-1.7.1.tar.gz	2016-02-18	461903 bytes	sha256
pgbouncer-1.7.tar.gz	2015-12-18	459080 bytes	sha256

PgBouncer 1.6

File	Date	Size	SHA256
pgbouncer-1.6.1.tar.gz	2015-09-03	431076 bytes	sha256
pgbouncer-1.6.tar.gz	2015-08-01	412700 bytes	sha256

PgBouncer 1.5

File	Date	Size	SHA256
pgbouncer-1.5.5.tar.gz	2015-04-09	336145 bytes	sha256
pgbouncer-1.5.4.tar.gz	2012-11-28	339610 bytes	sha256
pgbouncer-1.5.3.tar.gz	2012-09-12	339013 bytes	sha256
pgbouncer-1.5.2.tar.gz	2012-05-29	335338 bytes	sha256
pgbouncer-1.5.1.tar.gz	2012-04-17	334413 bytes	sha256
pgbouncer-1.5.tar.gz	2012-01-05	411488 bytes	sha256

PgBouncer 1.4

File	Date	Size	SHA256
pgbouncer-1.4.2.tgz	2011-06-16	283204 bytes	sha256
pgbouncer-1.4.1.tgz	2011-04-01	282728 bytes	sha256
pgbouncer-1.4.tgz	2011-01-11	231691 bytes	sha256

PgBouncer 1.3

File	Date	Size	SHA256
pgbouncer-1.3.4.tgz	2010-09-09	167957 bytes	sha256
pgbouncer-1.3.3.tgz	2010-05-10	167476 bytes	sha256
pgbouncer-1.3.2.tgz	2010-03-15	166756 bytes	sha256
pgbouncer-1.3.1.tgz	2009-07-06	161518 bytes	sha256
pgbouncer-1.3.tgz	2009-02-18	160154 bytes	sha256

PgBouncer 1.2

File	Date	Size	SHA256
pgbouncer-1.2.3.tgz	2008-08-08	145372 bytes	sha256
pgbouncer-1.2.2.tgz	2008-08-06	145017 bytes	sha256
pgbouncer-1.2.1.tgz	2008-08-04	144903 bytes	sha256
pgbouncer-1.2.tgz	2008-07-29	143915 bytes	sha256

PgBouncer 1.1

File	Date	Size	SHA256
pgbouncer-1.1.2.tgz	2007-12-10	122054 bytes	sha256
pgbouncer-1.1.1.tgz	2007-10-26	121042 bytes	sha256
pgbouncer-1.1.tgz	2007-10-09	120462 bytes	sha256

PgBouncer 1.0

File	Date	Size	SHA256
pgbouncer-1.0.8.tgz	2007-06-18	93636 bytes	sha256
pgbouncer-1.0.7.tgz	2007-04-19	93086 bytes	sha256
pgbouncer-1.0.6.tgz	2007-04-12	92244 bytes	sha256
pgbouncer-1.0.5.tgz	2007-04-11	91934 bytes	sha256
pgbouncer-1.0.4.tgz	2007-04-11	91889 bytes	sha256
pgbouncer-1.0.3.tgz	2007-04-11	91489 bytes	sha256
pgbouncer-1.0.2.tgz	2007-03-28	90555 bytes	sha256
pgbouncer-1.0.1.tgz	2007-03-15	89609 bytes	sha256
pgbouncer-1.0.tgz	2007-03-13	88587 bytes	sha256

二进制软件包

许多操作系统发行版提供了 PgBouncer 的原生软件包/移植版本，建议首先检查您的系统中是否已有可用的版本。

过期命令（expire）

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest 基于保留策略对全量备份进行轮换，策略可按数量或时间段定义。按数量保留时，过期操作只关注需要保留的备份数量，不考虑备份的创建时间。差异备份按数量进行保留，但当其依赖的全量备份过期时，差异备份也会随之过期。增量备份没有独立的保留策略——它们始终随关联的全量备份或差异备份一同过期。详情及示例请参见 全量备份保留策略 和 差异备份保留策略 章节。

版本发布说明

Mon, 01 Jan 0001 00:00:00 +0000

简介

pgBackRest 的版本号由主版本号和次版本号两部分组成。主版本升级可能破坏与上一主版本的兼容性，但 v2 版本与 v1 仓库完全兼容，且接受所有 v1 选项。次版本可包含漏洞修复和新功能，但不会更改仓库格式，并尽量避免修改选项和命名约定。v1 版本的文档可在此处查阅。版本说明中还可能包含"附加说明"，此部分变更仅涉及文档或测试套件，不直接影响 pgBackRest 代码库。

帮助命令（help）

Mon, 01 Jan 0001 00:00:00 +0000

help 命令提供三个层级的帮助信息：未指定命令时显示通用帮助；指定命令（例如 pgbackrest help backup）时显示该命令的完整说明及有效选项列表；在命令之外还指定了某个选项（例如 pgbackrest help backup type）时显示该选项在此命令下的完整说明。

版本变更日志

Mon, 01 Jan 0001 00:00:00 +0000

PgBouncer 1.25.x

2026-05-08 - PgBouncer 1.25.2 - “Human touch with fresh twist in title race full of uncertainties（充满不确定性的冠军争夺战中，人情味带来新意）”

常见问题解答

Mon, 01 Jan 0001 00:00:00 +0000

简介

常见问题解答旨在针对一些具体问题提供详细说明，这些问题可能未在用户指南、配置参考或命令参考中涵盖。如果在此处找不到您的问题，pgBackRest 在 GitHub 上的 Issues List 也是一个宝贵的资源。

性能与容量规划

Mon, 01 Jan 0001 00:00:00 +0000

典型 CPU 使用率数据显示，在 TCP 或 HTTP 关闭模式下，HAProxy 占用约 15% 的处理时间，内核占用约 85%；在 HTTP 持久连接模式下，HAProxy 占用约 30%，内核占用约 70%。这表明操作系统及其调优对整体性能有显著影响。

输出格式

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger 会根据输出文件扩展名，或 -x / --extension 选项选择格式。同一次解析可多次使用 -o / --outfile，同时生成多种格式。

格式	常用扩展名	最适合
HTML	`.html`	带图表的交互式人类可读报告
文本	`.txt`	终端查看与纯文本归档
二进制	`.bin`	可合并的中间统计数据与报告重建
JSON	`.json`	与其他软件集成；需要 `JSON::XS`
原始 CSV	自选输出文件	使用 `--dump-raw-csv` 导出逐行数据

HTML 与文本

默认输出为 out.html：

Info 命令（info）

Mon, 01 Jan 0001 00:00:00 +0000

info 命令可查询单个 stanza（stanza 是 pgBackRest 中用于标识一个 PostgreSQL 集群备份配置的逻辑名称）或所有 stanza 的信息。默认输出为文本格式，以人类可读的摘要展示所请求 stanza 的备份信息。该格式可能随版本更新而变化。

报告示例

Mon, 01 Jan 0001 00:00:00 +0000

示例内容由 pgBadger 11.8 于 2022 年 5 月生成。原始示例已与本站一起保存，因此即使无法访问上游服务器，也能继续使用报告导航、图表、样式与脚本。

示例	展示内容	本地副本
完整报告	PostgreSQL 活动与 PgBouncer 统计	打开完整报告
增量报告	日历索引、每周累计与每日页面	打开增量索引
错误与事件	仅包含错误和运行事件的报告	打开错误报告

完整报告

完整报告是一份自包含 HTML 文档。可通过顶部导航查看全局统计、查询、会话、连接、临时文件、检查点、自动清理、锁，以及 PgBouncer 专用图表。

常见问题解答

Mon, 01 Jan 0001 00:00:00 +0000

如何连接到 PgBouncer？

PgBouncer 扮演 PostgreSQL 服务器的角色，只需将客户端指向 PgBouncer 端口即可。

如何在多个服务器之间实现查询负载均衡？

PgBouncer 没有内置的多主机配置功能，但可以通过外部工具实现：

仓库获取命令（repo-get）

Mon, 01 Jan 0001 00:00:00 +0000

repo-get 命令类似于 Unix 的 cat 命令，但支持所有仓库类型。使用此命令需要提供完整的文件名，主要用于管理、排查和测试目的，不是常规 pgBackRest 使用流程中的必需命令。

若仓库已加密，repo-get 将自动解密文件。文件不会自动解压，但可将输出通过管道传递给相应的解压命令，例如 gzip -d。

版本历史

Mon, 01 Jan 0001 00:00:00 +0000

官网把版本新闻直接堆放在首页，内容停留在 12.4，并且误把 11.1–11.3 用互相冲突的日期重复渲染了一次。本站以固定上游 ChangeLog 为规范记录，只去除这些重复展示，同时补入后续 13.x 版本。每个系列均保留完整条目，并按从新到旧排序。

仓库列表命令（repo-ls）

Mon, 01 Jan 0001 00:00:00 +0000

repo-ls 类似于 Unix 的 ls 命令，但支持所有 pgBackRest 仓库类型。该命令接受一个路径参数，可以是绝对路径，也可以是相对于 --repo-path 所定义的仓库根路径的相对路径。此命令主要用于管理、排查和测试场景，并非常规部署的必要命令。

文档与社区

Mon, 01 Jan 0001 00:00:00 +0000

1. 可用文档

HAProxy 的完整文档由以下文件组成。请先查阅与问题相关的文档，以节省时间并获得最准确的答案。如果这些文档已经给出答案，请勿再向邮件列表重复提问。

恢复命令（restore）

Mon, 01 Jan 0001 00:00:00 +0000

restore 命令默认从第一个存有备份的仓库中自动选取最新备份（参见 快速开始 - 恢复备份 ）。仓库的检查顺序由 pgbackrest.conf 决定（例如先检查 repo1，再检查 repo2）。若要从特定仓库恢复，可使用 --repo 选项（例如 --repo=1）。若需恢复非最新的备份，可传入 --set 选项。

许可证与致谢

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger 是以 PostgreSQL License 发布的自由开源软件。只要保留版权与许可证声明，就可以免费使用、复制、修改与分发。

PostgreSQL License 原文

服务器命令（server）

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest 服务器允许在不使用 SSH 协议的情况下访问远程主机。

命令选项

TLS 服务器地址选项（`--tls-server-address`）

TLS 服务器地址。

2. 配置 HAProxy

Mon, 01 Jan 0001 00:00:00 +0000

2.1. 配置文件格式

HAProxy 的配置过程涉及三个主要参数来源：

命令行参数，始终具有最高优先级
配置文件，其格式在此处描述
运行进程的环境，若显式引用了某些环境变量

配置文件采用一种相对简单的分层格式，遵循若干基本规则：

服务器心跳命令（server-ping）

Mon, 01 Jan 0001 00:00:00 +0000

向 pgBackRest TLS 服务器发送 ping，确认其正在接受连接。此命令仅作为存活性检查，不进行身份验证。

若命令行中未指定主机，则使用 tls-server-host 选项的值。

命令选项

TLS 服务器地址选项（`--tls-server-address`）

TLS 服务器地址。

3. 全局段

Mon, 01 Jan 0001 00:00:00 +0000

“global” 段中的参数为进程级配置，通常与操作系统相关。这些参数通常只需一次性设置，一旦配置正确便无需再修改。部分参数在命令行中也有对应选项。

Stanza 创建命令（stanza-create）

Mon, 01 Jan 0001 00:00:00 +0000

stanza-create 命令须在 pgbackrest.conf 中完成 stanza 配置后再执行（stanza 是 pgBackRest 中用于标识一个 PostgreSQL 集群备份配置的逻辑名称）。若配置了多个仓库，stanza-create 会在每个仓库上分别建立 stanza。已创建的 stanza 会被跳过，因此即便新增了仓库，也可以随时安全地重复执行 stanza-create。

4. 代理

Mon, 01 Jan 0001 00:00:00 +0000

代理配置可位于一组段中：

defaults [<name>] [ from <defaults_name> ]
frontend <name> [ from <defaults_name> ]
backend <name> [ from <defaults_name> ]
listen <name> [ from <defaults_name> ]

前端段描述了一组用于接收客户端连接的监听套接字。

后端段描述了一组代理将连接以转发传入连接的服务器。

Stanza 删除命令（stanza-delete）

Mon, 01 Jan 0001 00:00:00 +0000

stanza-delete 命令用于删除仓库中与指定 stanza 关联的所有数据。stanza 是 pgBackRest 中用于标识一个 PostgreSQL 集群备份配置的逻辑名称。

警告：

此命令会永久删除指定 stanza 在 pgBackRest 仓库中的所有备份和归档数据，请谨慎使用。

5. 绑定与服务器选项

Mon, 01 Jan 0001 00:00:00 +0000

“bind”、“server” 和 “default-server” 关键字支持多种设置，具体取决于构建选项以及 HAProxy 所基于的系统。这些设置通常由一个单词组成，有时后接一个值，与 “bind” 或 “server” 语句位于同一行。所有这些选项均在本节中描述。

Stanza 升级命令（stanza-upgrade）

Mon, 01 Jan 0001 00:00:00 +0000

将 PostgreSQL 升级到新的主版本后，必须立即将所有 pgBackRest 配置中的 pg-path 更新为新的数据库位置，然后运行 stanza-upgrade 命令。若主机上配置了多个仓库，每个仓库都会执行 stanza 升级。若数据库处于离线状态，请使用 --no-online 选项。

6. 缓存

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy 提供一个缓存，专为小型对象（如 favicon、CSS 等）的缓存而设计。这是一个极简且低维护成本的缓存，运行于内存中。

缓存基于所有线程共享的内存区域，并划分为 1kB 的块。

启动命令（start）

Mon, 01 Jan 0001 00:00:00 +0000

如果 pgBackRest 进程之前已通过 stop 命令停止，可使用 start 命令重新允许它们运行。注意，此命令不会立即启动任何 pgBackRest 进程，只是解除运行限制。详情与示例请参见 启动与停止 。

通用选项

允许以 root 用户运行选项（`--allow-root`）

允许命令以 root 用户运行。

7. ACL 与样本提取

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy 可从请求或响应流、客户端或服务器信息、表格、环境信息等来源提取数据。提取此类数据的动作称为获取样本。获取后，这些样本可用于多种用途，例如作为粘性表的键，但最常见的用法是将其与称为模式的预定义常量数据进行匹配。

停止命令（stop）

Mon, 01 Jan 0001 00:00:00 +0000

禁止任何新的 pgBackRest 进程运行。默认情况下，正在运行的进程将被允许正常完成。使用 --force 选项可强制终止正在运行的进程。

stop 命令执行完成后，此后尝试运行的 pgBackRest 进程将返回错误。详情与示例请参见 启动与停止 。

常见问题

Mon, 01 Jan 0001 00:00:00 +0000

本节收录了关于 Patroni 最常见问题的解答，各子节聚焦于不同类别的问题。

希望这些内容能帮你解答大多数疑问。如果仍有疑问或遇到意外问题，请参阅 chatting 和 reporting_bugs ，了解如何获取帮助或提交问题报告。

验证命令（verify）

Mon, 01 Jan 0001 00:00:00 +0000

verify 用于验证仓库中的备份和归档是否有效。

命令选项

输出格式选项（`--output`）

输出类型。

支持以下输出类型：

版本历史

Mon, 01 Jan 0001 00:00:00 +0000

Version 4.1.5

发布于 2026-08-12

兼容性改进

兼容 PostgreSQL 14.24、15.19、16.15、17.11 与 18.6（Alexander Kukushkin）

9. 支持的过滤器

Mon, 01 Jan 0001 00:00:00 +0000

以下是官方支持的过滤器及其所接受的参数列表。根据编译选项的不同，部分过滤器可能不可用。可用过滤器的列表将在 HAProxy -vv. 中报告。

另请参见：“过滤器”

版本命令（version）

Mon, 01 Jan 0001 00:00:00 +0000

显示已安装的 pgBackRest 版本。

命令选项

输出格式选项（`--output`）

输出类型。

支持以下输出类型：

text — 以文本形式显示已安装的 pgBackRest 版本。
num — 以整数形式显示已安装的 pgBackRest 版本。

default: text
example: --output=num

10. FastCGI 应用程序

Mon, 01 Jan 0001 00:00:00 +0000

HAProxy 可以向 Responder FastCGI 应用发送 HTTP 请求。此功能自 HAProxy 2.1 版本起引入。为此，必须将服务器配置为使用 FastCGI 协议（在服务器行中使用关键字 “proto fcgi”），且后端管理这些服务器时，必须配置并使用一个 FastCGI 应用（在代理段中使用关键字 “use-fcgi-app”）。可以定义多个 FastCGI 应用，但每个后端在同一时间只能使用其中一个。

11. 粘性表与对等节点

Mon, 01 Jan 0001 00:00:00 +0000

在 HAProxy 中，stick-table 是一种机制，允许将一定数量的信息和指标与特定类型的键关联，并在最后一次更新后持续一定时间。这可视为表格中的一行多列数据，其中行号由键值决定，各列代表不同的衡量标准。

12. 其他配置段

Mon, 01 Jan 0001 00:00:00 +0000

以下所述段落使用频率较低，通常仅支持少量参数。它们之间不存在隐式关联。所有段均通过单一关键字启动。在 “global” 段之前禁止出现任何此类段。部分段的支持可能受构建选项限制（例如与 SSL 相关的任何功能）。

功能门控

Mon, 01 Jan 0001 00:00:00 +0000

本文概述了管理员可在 etcd 中指定的各种功能门控。

请参阅 feature stages 了解功能各阶段的说明。

概述

功能门控是一组描述 etcd 特性的 key=value 键值对。可使用 etcd 的 --feature-gates 命令行标志来开启或关闭这些特性。

常见问题

Mon, 01 Jan 0001 00:00:00 +0000

etcd，通用

etcd 是什么？

etcd 是一个一致性的分布式键值存储。主要用于分布式系统中的独立协调服务，专为存储可完全容纳在内存中的少量数据而设计。

库和工具

Mon, 01 Jan 0001 00:00:00 +0000

请注意，以下第三方库和工具未托管在 https://github.com/etcd-io 下，也未经 etcd 团队测试或维护。使用前应自行阅读相关资料并评估其可靠性。

工具

etcdctl - etcd 的命令行客户端
etcd-dump - 用于导出/恢复 etcd 的命令行工具
etcd-fs - etcd 的 FUSE 文件系统
etcddir - 实时同步 etcd 与本地目录的工具，支持 Windows 和 Linux
etcd-browser - 基于 AngularJS 的 Web 端键值编辑器，用于 etcd
etcd-lock - 基于 etcd 实现的领导者选举与分布式读写锁，支持 v2 版本
etcd-console - 基于 PHP 的 Web 端键值编辑器，用于 etcd
etcd-viewer - 使用 Java 编写的 etcd 键值存储编辑器/查看器
etcdtool - 将 etcd 目录导出/导入/编辑为 JSON/YAML/TOML 格式，并使用 JSON Schema 验证目录
etcdloadtest - 用于 etcd 3.0 及以上版本的命令行负载测试客户端
etcd-tui - 用于与 etcd 数据库交互的现代终端用户界面（TUI），可在终端中导航键、查看值、过滤数据，并直接管理 etcd 集群
etcdfinder - 一款快速、现代的 Web UI，支持 etcd v2 和 v3，具备即时搜索功能
lucas - 用于 Kubernetes etcd 3.0+ 集群的 Web 端键值查看器
etcd-manager - 一款现代、高效、跨平台且免费的 etcd 3.x 图形界面与客户端工具，支持 Windows、Linux 和 Mac
etcd-backup-restore - 用于定期且增量备份与恢复 etcd 的工具
etcd-druid - 用于部署 etcd 集群并管理日常运维操作的 Kubernetes Operator
etcdadm - 用于操作 etcd 集群的命令行工具
etcd-defrag - 更易用且智能的 etcd 碎片整理工具
etcdhelper - 适用于 IntelliJ 平台的 etcd 插件

库

以下各节按语言列出了 etcd 客户端库。

指标

Mon, 01 Jan 0001 00:00:00 +0000

etcd 使用 Prometheus 进行指标报告。指标可用于实时监控和调试。etcd 不会持久化其指标；若成员重启，指标将被重置。

查看可用指标最简单的方法是使用 cURL 访问指标端点 /metrics。其格式详见 Prometheus 文档。

发现服务协议

Mon, 01 Jan 0001 00:00:00 +0000

发现服务协议有助于新 etcd 成员在集群引导阶段通过共享的发现 URL 发现集群中的所有其他成员。

发现服务协议仅在集群引导阶段使用，不可用于运行时重配置或集群监控。

发现服务协议

Mon, 01 Jan 0001 00:00:00 +0000

发现服务协议有助于新 etcd 成员在集群引导阶段，通过共享的发现令牌和端点列表，发现集群中的所有其他成员。

发现服务协议仅在集群引导阶段使用，不可用于运行时重配置或集群监控。

日志记录约定

Mon, 01 Jan 0001 00:00:00 +0000

etcd 使用 zap 库记录应用程序输出，输出按级别进行分类。日志消息的级别依据以下约定确定：

DebugLevel 日志通常非常庞大，通常在生产环境中禁用。
- 示例：
  - 向远程对等成员发送一条普通消息
  - 将日志条目写入磁盘
InfoLevel 为默认的日志优先级。

Go 模块

Mon, 01 Jan 0001 00:00:00 +0000

etcd 项目（自版本 3.5 起）采用多个 golang 模块，托管于单个仓库中。

以下是各个模块：

go.etcd.io/etcd/api/v3 - 包含 API 定义（如 protos 与 proto 生成的库），定义了 etcd 客户端与服务器之间的通信协议。
go.etcd.io/etcd/pkg/v3 - etcd 使用的通用工具包集合，不针对 etcd 本身。仅当某个包未来可能被移出至独立仓库时，才应归入此处。请避免在此处添加依赖关系复杂的代码，因为这些依赖会自动成为客户端库的依赖（我们希望客户端库保持轻量）。

术语表

Mon, 01 Jan 0001 00:00:00 +0000

本文定义了 etcd 文档、命令行和源代码中使用的各种术语。

告警

当集群需要操作员干预以保持可靠性时，etcd 服务器会触发告警。

系统限制

Mon, 01 Jan 0001 00:00:00 +0000

请求大小限制

etcd 专为处理典型的元数据类小规模键值对而设计。虽然较大请求也能正常工作，但可能增加其他请求的延迟。默认情况下，任何请求的最大大小为 1.5 MiB。此限制可通过 etcd 服务器的 --max-request-bytes 标志进行配置。

etcd 功能

Mon, 01 Jan 0001 00:00:00 +0000

本文概述了 etcd 的各项功能，旨在帮助用户更好地理解这些功能及其相关弃用流程。若想了解 etcd 功能的开发方式，请参阅开发指南。

etcd 功能分为三个阶段：实验性、稳定和不安全。可通过运行 etcd --help 获取功能列表。

API 参考

Mon, 01 Jan 0001 00:00:00 +0000

本文 API 参考由命名的 .proto 文件自动生成。

服务 `Auth` (api/etcdserverpb/rpc.proto)

方法	请求类型	响应类型	描述
AuthEnable	AuthEnableRequest	AuthEnableResponse	AuthEnable 启用身份认证。
AuthDisable	AuthDisableRequest	AuthDisableResponse	AuthDisable 禁用身份认证。
AuthStatus	AuthStatusRequest	AuthStatusResponse	AuthStatus 显示身份认证状态。
Authenticate	AuthenticateRequest	AuthenticateResponse	Authenticate 处理身份认证请求。
UserAdd	AuthUserAddRequest	AuthUserAddResponse	UserAdd 添加新用户。用户名不能为空。
UserGet	AuthUserGetRequest	AuthUserGetResponse	UserGet 获取用户详细信息。
UserList	AuthUserListRequest	AuthUserListResponse	UserList 获取所有用户的列表。
UserDelete	AuthUserDeleteRequest	AuthUserDeleteResponse	UserDelete 删除指定用户。
UserChangePassword	AuthUserChangePasswordRequest	AuthUserChangePasswordResponse	UserChangePassword 更改指定用户的密码。
UserGrantRole	AuthUserGrantRoleRequest	AuthUserGrantRoleResponse	UserGrant 为指定用户授予角色。
UserRevokeRole	AuthUserRevokeRoleRequest	AuthUserRevokeRoleResponse	UserRevokeRole 撤销指定用户的指定角色。
RoleAdd	AuthRoleAddRequest	AuthRoleAddResponse	RoleAdd 添加新角色。角色名不能为空。
RoleGet	AuthRoleGetRequest	AuthRoleGetResponse	RoleGet 获取角色详细信息。
RoleList	AuthRoleListRequest	AuthRoleListResponse	RoleList 获取所有角色的列表。
RoleDelete	AuthRoleDeleteRequest	AuthRoleDeleteResponse	RoleDelete 删除指定角色。
RoleGrantPermission	AuthRoleGrantPermissionRequest	AuthRoleGrantPermissionResponse	RoleGrantPermission 为指定角色授予指定键或范围的权限。
RoleRevokePermission	AuthRoleRevokePermissionRequest	AuthRoleRevokePermissionResponse	RoleRevokePermission 撤销指定角色的指定键或范围的权限。

服务 `Cluster` (api/etcdserverpb/rpc.proto)

方法	请求类型	响应类型	描述
MemberAdd	MemberAddRequest	MemberAddResponse	MemberAdd 将成员添加至集群。
MemberRemove	MemberRemoveRequest	MemberRemoveResponse	MemberRemove 从集群中移除现有成员。
MemberUpdate	MemberUpdateRequest	MemberUpdateResponse	MemberUpdate 更新成员配置。
MemberList	MemberListRequest	MemberListResponse	MemberList 列出集群中的所有成员。
MemberPromote	MemberPromoteRequest	MemberPromoteResponse	MemberPromote 将学习者成员（非投票成员）提升为 Raft 投票成员。

服务 `KV` (api/etcdserverpb/rpc.proto)

方法	请求类型	响应类型	描述
Range	RangeRequest	RangeResponse	Range 从键值存储中获取指定范围内的键。
Put	PutRequest	PutResponse	Put 将指定键写入键值存储。Put 请求会递增键值存储的修订版本，并在事件历史中生成一个事件。
DeleteRange	DeleteRangeRequest	DeleteRangeResponse	DeleteRange 从键值存储中删除指定范围内的键。删除请求会递增键值存储的修订版本，并为每个被删除的键在事件历史中生成一个删除事件。
Txn	TxnRequest	TxnResponse	Txn 在单个事务中处理多个请求。事务请求会递增键值存储的修订版本，并为每个完成的请求生成具有相同修订版本的事件。不允许在同一个事务中多次修改同一键。
Compact	CompactionRequest	CompactionResponse	Compact 对 etcd 键值存储中的事件历史进行压缩。键值存储应定期执行压缩，否则事件历史将无限增长。

服务 `Lease` (api/etcdserverpb/rpc.proto)

方法	请求类型	响应类型	描述
LeaseGrant	LeaseGrantRequest	LeaseGrantResponse	LeaseGrant 创建一个租约，若服务器在指定的生存时间（TTL）内未收到保活请求，则该租约将过期。若租约过期，所有关联该租约的键将被过期并删除。每个过期的键都会在事件历史中生成一个删除事件。
LeaseRevoke	LeaseRevokeRequest	LeaseRevokeResponse	LeaseRevoke 撤销一个租约。所有关联该租约的键将过期并被删除。
LeaseKeepAlive	LeaseKeepAliveRequest	LeaseKeepAliveResponse	LeaseKeepAlive 通过客户端向服务器流式发送保活请求，并从服务器流式接收保活响应，以维持租约的活跃状态。
LeaseTimeToLive	LeaseTimeToLiveRequest	LeaseTimeToLiveResponse	LeaseTimeToLive 获取租约信息。
LeaseLeases	LeaseLeasesRequest	LeaseLeasesResponse	LeaseLeases 列出所有现有的租约。

服务 `Maintenance` (api/etcdserverpb/rpc.proto)

方法	请求类型	响应类型	描述
Alarm	AlarmRequest	AlarmResponse	告警用于激活、停用和查询与集群健康状态相关的告警。
Status	StatusRequest	StatusResponse	状态用于获取成员的状态。
Defragment	DefragmentRequest	DefragmentResponse	碎片整理用于对成员的后端数据库进行碎片整理，以恢复存储空间。
Hash	HashRequest	HashResponse	哈希用于计算整个后端键空间的哈希值，包括存储中的键、租约及其他桶。此功能仅用于测试！请勿在存在持续事务的生产环境中依赖此操作，因为哈希操作不持有 MVCC 锁。如需对“键”桶进行一致性检查，请改用“HashKV” API。
HashKV	HashKVRequest	HashKVResponse	哈希键用于计算指定修订版本之前所有 MVCC 键的哈希值。它仅遍历后端存储中的“键”桶。
Snapshot	SnapshotRequest	SnapshotResponse	快照通过流将成员的整个后端数据发送给客户端。
MoveLeader	MoveLeaderRequest	MoveLeaderResponse	转移领导者用于请求当前领导者将其领导权转移给指定接收节点。
Downgrade	DowngradeRequest	DowngradeResponse	降级用于请求降级、验证可行性或取消集群版本的降级操作。自 etcd 3.5 起支持。

服务 `Watch` (api/etcdserverpb/rpc.proto)

方法	请求类型	响应类型	描述
Watch	WatchRequest	WatchResponse	Watch 用于监听发生的事件或已发生的事件。输入和输出均为流；输入流用于创建和取消监听器，输出流用于发送事件。一个 Watch RPC 可以同时监听多个键范围，一次性流式传输多个监听的事件。可以从最后一次压缩的修订版本开始，监听完整的事件历史。

消息 `AlarmMember` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
memberID	memberID 是与触发告警相关的成员的 ID。	uint64
alarm	alarm 是已触发的告警类型。	AlarmType

消息 `AlarmRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
action	action 表示要发出的告警请求类型。action 可以是获取告警状态、激活告警，或停用已触发的告警。	AlarmAction
memberID	memberID 表示与告警关联的成员 ID。如果 memberID 为 0，则该告警请求涵盖所有成员。	uint64
alarm	alarm 表示本次请求所考虑的告警类型。	AlarmType

消息 `AlarmResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader
alarms	alarms 是与告警请求相关联的告警列表。	(slice of) AlarmMember

消息 `AuthDisableRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option

消息 `AuthDisableResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthEnableRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option

消息 `AuthEnableResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthRoleAddRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name	name 是要添加到身份认证系统中的角色名称。	string

消息 `AuthRoleAddResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthRoleDeleteRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
role		string

消息 `AuthRoleDeleteResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthRoleGetRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
role		string

消息 `AuthRoleGetResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
header		ResponseHeader
perm		(切片) authpb.Permission

消息 `AuthRoleGrantPermissionRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name	name 是将被授予权限的角色名称。	string
perm	perm 是要授予角色的权限。	authpb.Permission

消息 `AuthRoleGrantPermissionResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthRoleListRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option

消息 `AuthRoleListResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader
roles		(slice of) string

消息 `AuthRoleRevokePermissionRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
role		string
key		bytes
range_end		bytes

消息 `AuthRoleRevokePermissionResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthStatusRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option

消息 `AuthStatusResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader
enabled		bool
authRevision	authRevision 是认证存储系统的当前修订版本	uint64

消息 `AuthUserAddRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name		string
password		string
options		authpb.UserAddOptions
hashedPassword		string

消息 `AuthUserAddResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthUserChangePasswordRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name	name 是要更改密码的用户的名称。	string
password	password 是用户的新密码。请注意，该字段将在 API 层被移除。	string
hashedPassword	hashedPassword 是用户的新的哈希密码。请注意，该字段将在 API 层被初始化。	string

消息 `AuthUserChangePasswordResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthUserDeleteRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name	name 是要删除的用户名称。	string

消息 `AuthUserDeleteResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthUserGetRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name		string

消息 `AuthUserGetResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader
roles		(slice of) string

消息 `AuthUserGrantRoleRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
user	user 是应被授予指定角色的用户名。	string
role	role 是应授予用户的角色名称。	string

消息 `AuthUserGrantRoleResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthUserListRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option

消息 `AuthUserListResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader
users		(slice of) string

消息 `AuthUserRevokeRoleRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name		string
role		string

消息 `AuthUserRevokeRoleResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader

消息 `AuthenticateRequest` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
name		string
password		string

消息 `AuthenticateResponse` (api/etcdserverpb/rpc.proto)

字段	描述	类型
(versionpb.etcd_version_msg)		option
header		ResponseHeader
token	token 是可用于后续 RPC 的授权令牌	string

消息 `CompactionRequest` (api/etcdserverpb/rpc.proto)

CompactionRequest 对键值存储执行压缩，直至指定的修订版本。所有修订版本小于压缩修订版本的已覆盖键将被移除。

API 参考：并发

Mon, 01 Jan 0001 00:00:00 +0000

本文 API 参考由命名的 .proto 文件自动生成。

服务 `Lock` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

锁服务将客户端锁功能以 gRPC 接口的形式暴露。

方法	请求类型	响应类型	描述
Lock	LockRequest	LockResponse	Lock 在指定名称的锁上获取分布式共享锁。成功时，将返回一个唯一键，该键在调用方持有锁期间持续存在。该键可与事务配合使用，以确保对 etcd 的更新仅在持有锁所有权时发生。锁将持续持有，直至对键调用 Unlock，或与所有者关联的租约到期。
Unlock	UnlockRequest	UnlockResponse	Unlock 接收 Lock 返回的键，并释放对锁的持有。等待获取锁的下一个 Lock 调用者将被唤醒，并获得锁的所有权。

消息 `LockRequest` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

字段	描述	类型
name	name 是要获取的分布式共享锁的标识符。	bytes
lease	lease 是将附加到锁所有权的租约 ID。如果该租约到期或被撤销且当前持有锁，则锁会自动释放。使用相同租约调用 Lock 将被视为一次获取；使用相同租约两次锁定为无操作。	int64

消息 `LockResponse` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

字段	描述	类型
header		etcdserverpb.ResponseHeader
key	键是在锁持有者持有锁期间存在于 etcd 中的键。用户不应修改此键，否则锁可能表现出未定义行为。	bytes

消息 `UnlockRequest` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

字段	描述	类型
key	key 是由 Lock 分配的锁所有权键。	bytes

消息 `UnlockResponse` (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)

字段	描述	类型
header		etcdserverpb.ResponseHeader

服务 `Election` (server/etcdserver/api/v3election/v3electionpb/v3election.proto)

选举服务通过 gRPC 接口向客户端暴露选举功能。

配置选项

Mon, 01 Jan 0001 00:00:00 +0000

可以通过以下方式配置 etcd：

命令行标志
环境变量：每个标志都有一个对应的环境变量，其名称与标志相同，但前缀为 ETCD_，并以全大写和 [蛇形命名法][] 格式化。例如，--some-flag 对应 ETCD_SOME_FLAG。
配置文件

警告

请注意：如果混合使用配置选项，则以下规则适用。

硬件推荐

Mon, 01 Jan 0001 00:00:00 +0000

etcd 在资源有限的开发或测试环境中通常运行良好；在笔记本电脑或廉价云主机上开发 etcd 是常见做法。然而，在生产环境中运行 etcd 集群时，遵循一些硬件建议有助于实现有效的系统管理。这些建议并非硬性规定，而是构建稳健生产部署的良好起点。和往常一样，部署前应使用模拟工作负载进行测试。

支持的平台

Mon, 01 Jan 0001 00:00:00 +0000

支持层级

etcd 可在不同平台上运行，但其提供的保证取决于平台的支持级别：

Tier 1：由 [etcd 维护者][] 完全支持；etcd 保证通过所有测试，包括功能测试和健壮性测试。
Tier 2：etcd 保证通过集成测试和端到端测试，但不保证通过功能测试或健壮性测试。
Tier 3：etcd 保证可构建，可能仅进行轻度测试（或未测试），因此应视为 不稳定。

当前支持

下表列出了当前支持的平台及其对应的 etcd 支持级别：

基准测试

Mon, 01 Jan 0001 00:00:00 +0000

基准测试

etcd 性能基准测试结果将定期发布，并在以下各版本中持续追踪：

内存使用基准

它记录了在不同场景下的预期内存使用情况。

存储内存使用量基准测试

Mon, 01 Jan 0001 00:00:00 +0000

etcd 存储的两个组件会占用物理内存。etcd 进程分配了一个 内存索引，用于加速键的查找。进程的 页缓存 由操作系统管理，用于存储从磁盘读取的最近访问数据，以便快速重用。

监听内存使用量基准测试

Mon, 01 Jan 0001 00:00:00 +0000

说明

监听功能正处于积极开发中，其内存使用量可能随开发进展而变化。我们预计其内存使用量不会显著超过以下所述数值。

etcd 的一个核心目标是支持大量客户端执行海量监听操作。etcd 旨在支持 O(10k) 个客户端、O(100K) 个监听流（每个客户端约 O(10) 个监听流）以及 O(10M) 个总监听操作（每个监听流约 O(100) 个监听）。每个单独监听操作所消耗的内存占 etcd 整体内存使用量的最大部分，因此成为当前及未来优化的重点。

etcd v3 基准测试

Mon, 01 Jan 0001 00:00:00 +0000

物理机

GCE n1-highcpu-2 机器类型

1x 专用本地 SSD，挂载于 /var/lib/etcd
1x 专用慢速磁盘，用于操作系统
1.8 GB 内存
2x CPU
etcd 版本 2.2.0

etcd 集群

1 以 v3 演示模式运行的 etcd 成员

etcd v2.2.0-rc 内存基准测试

Mon, 01 Jan 0001 00:00:00 +0000

物理机

GCE n1-standard-2 机器类型

1 个专用本地 SSD，挂载于 /var/lib/etcd
1 个专用慢速磁盘，用于操作系统
7.5 GB 内存
2 个 CPU

etcd

etcd Version: 2.2.0-rc.0+git
Git SHA: 103cb5c
Go Version: go1.5
Go OS/Arch: linux/amd64

测试

启动一个由 3 个成员组成的 etcd 集群，每个成员使用 2 个核心。

etcd v2.2.0-rc 基准测试

Mon, 01 Jan 0001 00:00:00 +0000

物理机

GCE n1-highcpu-2 机器类型

1 个专用本地 SSD，挂载于 /var/lib/etcd
1 个专用慢速磁盘，用于操作系统
1.8 GB 内存
2 个 CPU

etcd 集群

3 etcd 2.2.0-rc 成员，每个成员运行在单台机器上。

etcd v2.2.0 基准测试

Mon, 01 Jan 0001 00:00:00 +0000

物理机

GCE n1-highcpu-2 机器类型

1 块专用本地 SSD，挂载为 etcd 数据目录
1 块专用慢速磁盘，用于操作系统
1.8 GB 内存
2 个 CPU

etcd 集群

3 etcd 2.2.0 成员，每个成员运行在单台机器上。

etcd v2.1.0 基准测试

Mon, 01 Jan 0001 00:00:00 +0000

物理机

GCE n1-highcpu-2 机器类型

1 块专用本地 SSD，挂载于 /var/lib/etcd
1 块专用慢速磁盘，用于操作系统
1.8 GB 内存
2 个 CPU
etcd 版本 2.1.0 alpha

etcd 集群

3 个 etcd 成员，每个成员运行在单台机器上

参考 on PIG.CENTER

pgBadger 13.x 版本记录

v13.2 · 2025-12-29

注解命令（annotate）

命令选项

备份注解选项（--annotation）

动态配置

新闻

pgBackRest 2.59.1 正式发布

pgBadger 12.x 版本记录

v12.4 · 2023-12-25

归档获取命令（archive-get）

YAML 配置参数

全局/通用

配置：pgbouncer.ini

描述

pgBadger 11.x 版本记录

v11.8 · 2022-04-08

归档推送命令（archive-push）

Patroni 配置

环境变量

全局/通用

日志

命令行参考

用法与选项

pgBadger 10.x 版本记录

v10.3 · 2019-02-14

备份命令（backup）

Patroni REST API

命令参考

简介

pgBadger 9.x 版本记录

v9.2 · 2017-07-27

检查命令（check）

HAProxy 3.4.4 中文文档

patronictl 命令行

配置

配置参考

简介

源码发布版下载

PgBouncer 1.25

PgBouncer 1.24

PgBouncer 1.23

PgBouncer 1.22

PgBouncer 1.21

PgBouncer 1.20

PgBouncer 1.19

PgBouncer 1.18

PgBouncer 1.17

PgBouncer 1.16

PgBouncer 1.15

PgBouncer 1.14

PgBouncer 1.13

PgBouncer 1.12

PgBouncer 1.11

PgBouncer 1.10

PgBouncer 1.9

PgBouncer 1.8

PgBouncer 1.7

PgBouncer 1.6

PgBouncer 1.5

PgBouncer 1.4

PgBouncer 1.3

PgBouncer 1.2

PgBouncer 1.1

PgBouncer 1.0

二进制软件包

过期命令（expire）

版本发布说明

简介

帮助命令（help）

版本变更日志

PgBouncer 1.25.x

常见问题解答

简介

性能与容量规划

输出格式

HTML 与文本

Info 命令（info）

报告示例

备份注解选项（`--annotation`）

TLS 服务器地址选项（`--tls-server-address`）

TLS 服务器地址选项（`--tls-server-address`）

允许以 root 用户运行选项（`--allow-root`）

输出格式选项（`--output`）

输出格式选项（`--output`）

服务 `Auth` (api/etcdserverpb/rpc.proto)

服务 `Cluster` (api/etcdserverpb/rpc.proto)

服务 `KV` (api/etcdserverpb/rpc.proto)

服务 `Lease` (api/etcdserverpb/rpc.proto)

服务 `Maintenance` (api/etcdserverpb/rpc.proto)

服务 `Watch` (api/etcdserverpb/rpc.proto)