PostgreSQL 文档检索
PG 18 · 按类别浏览,或输入名称与关键词
分类索引819
pg_amcheck --progress-P--progress
显示进度信息。进度信息包括已完成检查的关系数量及其总大小,也包括最终将要检查的关系总数及这些关系的估计大小。pg_amcheck › 选项
pg_amcheck --relation=pattern-r pattern--relation=pattern
检查匹配指定pattern的关系,除非另有排除。此选项可指定多次。 匹配模式可以是未经限定的,例如myrel*;也可以是模式限定的,例如myschema*.myrel*;或者同时带数据库限定和模式限定,例如mydb*.myschema*.myrel*。数据库限定的模式会把匹配的数据库加入待检查数据库列表。pg_amcheck › 选项
pg_amcheck --rootdescend--rootdescend
对于检查的每个索引,使用amcheck的rootdescend选项,为每个元组从根页重新执行一次搜索,从而在叶级重新找到这些元组。 使用此选项也会隐式选择--parent-check选项。 这种验证形式最初是为协助开发 B-树索引特性而编写的。它在帮助检测实际发生的那类损坏方面可能用途有限,甚至毫无帮助。它还可能使损坏检查耗时显著增加,并显著增加服务…pg_amcheck › 选项
pg_amcheck --schema=pattern-s pattern--schema=pattern
检查匹配指定pattern的模式中的表和索引,除非另有排除。此选项可指定多次。 若只想选择名称匹配特定模式的那些模式中的表,可考虑使用类似--table=SCHEMAPAT.* --no-dependent-indexes的写法。若只想选择索引,可考虑使用类似--index=SCHEMAPAT.*的写法。 模式匹配串可以带数…pg_amcheck › 选项
pg_amcheck --skip=option--skip=option
如果给定all-frozen,表损坏检查会跳过所有表中标记为全冻结的页面。 如果给定all-visible,表损坏检查会跳过所有表中标记为全可见的页面。 默认不跳过任何页面。这可以显式指定为none,但因为这是默认值,通常无需写出。pg_amcheck › 选项
pg_amcheck --startblock=block--startblock=block
从指定块号开始检查。如果被检查的表关系块数少于这个数字,将发生错误。此选项不适用于索引,而且大概只在检查单个表关系时才有用。进一步的注意事项见--endblock。pg_amcheck › 选项
pg_amcheck --table=pattern-t pattern--table=pattern
检查匹配指定pattern的表,除非另有排除。此选项可指定多次。 这与--relation选项类似,但它只适用于表、物化视图和序列,不适用于索引。pg_amcheck › 选项
pg_amcheck --username=username-U--username=username
连接时使用的用户名。pg_amcheck › 选项
pg_amcheck --verbose-v--verbose
打印更多消息。特别是,它会为每个正在检查的关系打印一条消息,并提高服务器错误显示的详细程度。pg_amcheck › 选项
pg_amcheck --version-V--version
打印pg_amcheck版本并退出。pg_amcheck › 选项
pg_archivecleanuppg_archivecleanup — 清理 PostgreSQL WAL 归档文件
服务端程序
pg_archivecleanup [ option ...] archivelocation oldestkeptwalfile
手册中的可执行程序 pg_archivecleanup
程序版本 10.23
参考清单 服务端程序
选项定义组 5
手册中的选项
在 stderr …命令行工具 · 服务端程序
pg_basebackuppg_basebackup — 获取 PostgreSQL 集簇的基础备份
客户端程序
pg_basebackup [ option ...]
手册中的可执行程序 pg_basebackup
程序版本 10.23
参考清单 客户端程序
选项定义组 26
手册中的选项
设置写入输出的目标目录。如果该目录不存在, pg_basebackup 会创建它(以及所有缺失的父目录)。如果…命令行工具 · 客户端程序
pg_basebackup --checkpoint={fast|spread}-c {fast|spread}--checkpoint={fast|spread}
将检查点模式设置为 fast(立即)或 spread(默认)(见第 25.3.4 节)。pg_basebackup › 选项
pg_basebackup --compress=[{client|server}-]method[:detail]-Z level-Z [{client|server}-]method[:detail]--compress=level--compress=[{client|server}-]method[:detail]
请求对备份进行压缩。如果包含client或server,则指定压缩执行的位置。在服务器端压缩会减少传输带宽占用,但会增加服务器 CPU 消耗。默认值是client,但使用…pg_basebackup › 选项
pg_basebackup --create-slot-C--create-slot
指定在开始备份之前,应创建由--slot选项指定名称的复制槽。如果该槽已经存在,则会报错。pg_basebackup › 选项
pg_basebackup --dbname=connstr-d connstr--dbname=connstr
以连接字符串的形式指定用于连接服务器的参数;这些参数会覆盖任何相互冲突的命令行选项。 出于与其他客户端应用保持一致的考虑,此选项名为--dbname;但由于pg_basebackup并不连接到集簇中的某个特定数据库,连接字符串中包含的数据库名会被服务器忽略。不过,以这种方式提供的数据库名会覆盖默认数据库名(replicati…pg_basebackup › 选项
pg_basebackup --format=format-F format--format=format
选择输出格式。format可以是以下值之一: pplain # 将输出写为普通文件,其布局与源服务器的数据目录和表空间相同。当集簇没有额外表空间时,整个数据库都会放在目标目录中。如果集簇包含额外表空间,则主数据目录会放在目标目录中,而其他所有表空间都会放在与源服务器上相同的绝对路径中。(如需改变这一点,见--tablespace…pg_basebackup › 选项
pg_basebackup --gzip-z--gzip
启用 tar 文件输出的 gzip 压缩,使用默认压缩级别。压缩仅在使用 tar 格式时可用,并且所有 tar 文件名都会自动添加.gz后缀。pg_basebackup › 选项
pg_basebackup --help-?--help
显示pg_basebackup命令行参数的帮助并退出。pg_basebackup › 选项
pg_basebackup --host=host-h host--host=host
指定服务器运行所在机器的主机名。如果该值以斜线开头,则它会被用作 Unix 域套接字的目录。默认值取自PGHOST环境变量(如果已设置);否则会尝试使用 Unix 域套接字连接。pg_basebackup › 选项
pg_basebackup --incremental=old_manifest_file-i old_manifest_file--incremental=old_manifest_file
执行增量备份。必须提供参考备份的备份清单;该文件将被上传到服务器,随后服务器会返回所请求的增量备份。pg_basebackup › 选项
pg_basebackup --label=label-l label--label=label
设置备份标签。如果未指定,则使用默认值“pg_basebackup base backup”。pg_basebackup › 选项
pg_basebackup --manifest-checksums=algorithm--manifest-checksums=algorithm
指定应用到备份清单中每个文件的校验和算法。目前可用的算法有NONE、CRC32C、SHA224、SHA256、SHA384和SHA512。默认值为CRC32C。 如果选择NONE,备份清单将不包含任何校验和。否则,它将包含使用指定算法为备份中每个文件计算的校验和。此外,清单始终会包含其自身内容的SHA256校验和。S…pg_basebackup › 选项
pg_basebackup --manifest-force-encode--manifest-force-encode
强制将备份清单中的所有文件名编码为十六进制。如果未指定此选项,则只对非 UTF8 文件名进行十六进制编码。此选项主要用于测试读取备份清单文件的工具是否能正确处理这种情况。pg_basebackup › 选项
pg_basebackup --max-rate=rate-r rate--max-rate=rate
设置从源服务器收集数据时允许的最大传输速率。这有助于限制pg_basebackup对服务器的影响。取值单位为每秒千字节。使用后缀M表示每秒兆字节。也接受后缀k,但没有实际影响。有效取值范围为每秒 32 千字节到每秒 1024 兆字节。 此选项始终影响数据目录的传输。只有当收集方法为fetch时,WAL 文件的传输才会受到影响。pg_basebackup › 选项
pg_basebackup --no-clean-n--no-clean
默认情况下,当pg_basebackup因错误中止时,它会删除在发现自己无法完成任务之前可能已创建的所有目录(例如目标目录和预写式日志目录)。此选项会禁止这种清理,因此对调试很有帮助。 请注意,无论是否使用此选项,表空间目录都不会被清理。pg_basebackup › 选项
pg_basebackup --no-estimate-size--no-estimate-size
阻止服务器估算将要流式传输的备份数据总量,因此pg_stat_progress_basebackup视图中的backup_total列将始终为NULL。 如果不使用此选项,备份会先枚举整个数据库的大小,然后再回过头来发送实际内容。这可能会让备份耗时略长,特别是在发送第一批数据之前所需时间会更久。如果这种估算耗时过长,此选项就很有用,因为它可…pg_basebackup › 选项
pg_basebackup --no-manifest--no-manifest
禁止生成备份清单。如果未指定此选项,服务器将生成并发送一个备份清单,可使用pg_verifybackup进行验证。该清单列出了备份中的每一个文件,但不包括可能包含在其中的任何 WAL 文件。它还会保存每个文件的大小、最后修改时间以及可选的校验和。pg_basebackup › 选项
pg_basebackup --no-password-w--no-password
禁止发出密码提示。如果服务器要求密码认证,而又无法通过其他方式(例如.pgpass文件)获得密码,则连接尝试将失败。此选项对于批处理作业和脚本很有用,因为那种场景下通常没有用户在场输入密码。pg_basebackup › 选项
pg_basebackup --no-slot--no-slot
防止为备份创建临时复制槽。 默认情况下,如果选择了 WAL 流式传输,但没有使用-S选项给出槽名,那么会创建一个临时复制槽(如果源服务器支持)。 此选项的主要目的是在服务器没有空闲复制槽时,仍然允许执行基础备份。几乎总是首选使用复制槽,因为它能防止服务器在备份期间移除所需的 WAL。pg_basebackup › 选项
pg_basebackup --no-sync-N--no-sync
默认情况下,pg_basebackup会等待所有文件都被安全写入磁盘。此选项会使pg_basebackup不经等待就直接返回,因此速度更快,但这意味着如果随后操作系统崩溃,基础备份可能会损坏。通常,此选项适合测试,但不应用于创建生产环境安装。pg_basebackup › 选项
pg_basebackup --no-verify-checksums--no-verify-checksums
如果获取基础备份的服务器启用了校验和,则禁用对这些校验和的验证。 默认情况下,会验证校验和;校验和验证失败将导致非零退出状态。不过,在这种情况下,基础备份不会被删除,就像使用了--no-clean一样。校验和验证失败也会在pg_stat_database视图中报告。pg_basebackup › 选项
pg_basebackup --password-W--password
强制pg_basebackup在连接源服务器之前提示输入密码。 此选项绝非必需,因为如果服务器要求密码认证,pg_basebackup会自动提示输入密码。不过,pg_basebackup会浪费一次连接尝试来发现服务器需要密码。在某些情况下,输入-W以避免额外的连接尝试是值得的。pg_basebackup › 选项
pg_basebackup --pgdata=directory-D directory--pgdata=directory
设置写入输出的目标目录。如果该目录不存在,pg_basebackup会创建它(以及所有缺失的父目录)。如果该目录已经存在,则必须为空。 当备份采用 tar 格式时,目标目录可以指定为-(短横线),从而将 tar 文件写到stdout。 此选项是必需的。pg_basebackup › 选项
pg_basebackup --port=port-p port--port=port
指定服务器监听连接所使用的 TCP 端口,或本地 Unix 域套接字文件扩展名。默认使用PGPORT环境变量中的值(如果已设置),否则使用编译时确定的默认值。pg_basebackup › 选项
pg_basebackup --progress-P--progress
启用进度报告。打开此选项后,会在备份过程中给出一个近似的进度报告。由于数据库在备份过程中可能发生变化,因此这只是近似值,最终未必恰好结束在100%。特别是当备份中包含 WAL 时,总数据量无法预先估计;在这种情况下,一旦进度超过不含 WAL 时的总估计值,估计目标大小就会继续增加。pg_basebackup › 选项
pg_basebackup --slot=slotname-S slotname--slot=slotname
此选项只能与-X stream一起使用。它会使 WAL 流式传输使用指定的复制槽。如果此基础备份打算用作使用复制槽的流复制备库,那么该备库应将同一个复制槽名称用作primary_slot_name的值。这样可以确保主库在基础备份结束与新备库开始流复制之间的这段时间内,不会移除任何必需的 WAL 数据。 指定的复制槽必须已经存…pg_basebackup › 选项
pg_basebackup --status-interval=interval-s interval--status-interval=interval
指定发送回源服务器的状态包之间相隔的秒数。较小的值可以让服务器端对备份进度的监控更精确。值为零时会完全禁用周期性状态更新,不过当服务器请求时仍会发送更新,以避免因超时而断开连接。默认值是 10 秒。pg_basebackup › 选项
pg_basebackup --sync-method=method--sync-method=method
设置为fsync(默认)时,pg_basebackup会递归打开并同步备份目录中的所有文件。使用普通文件格式时,查找文件会跟随 WAL 目录和各已配置表空间的符号链接。 在 Linux 上,也可以使用syncfs,让操作系统同步包含备份目录的整个文件系统。使用普通文件格式时,pg_basebackup还会同步包含 WAL 文件和各表空间…pg_basebackup › 选项
pg_basebackup --tablespace-mapping=olddir=newdir-T olddir=newdir--tablespace-mapping=olddir=newdir
在备份期间,将目录olddir中的表空间重定位到newdir。要使此选项生效,olddir必须与源服务器上定义的该表空间路径完全一致。(但如果源服务器上在olddir中没有表空间,也不算错误。)与此同时,newdir是接收主机文件系统中的一个目录。与主目标目录一样,newdir…pg_basebackup › 选项
更多结果
输入名称或关键词,从 PostgreSQL 手册与扩展目录中直接找到定义。
pg17: 限定版本 ex: 只搜扩展 ↑↓ 选择 ↵ 打开