pgsql: doc: Clarify that base backup progress counts uncompressed archi

From: Fujii Masao <fujii(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Clarify that base backup progress counts uncompressed archi
Date: 2026-10-14 10:57:41
Message-ID: E1xGwg1-00000001aDR-3jkk@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

doc: Clarify that base backup progress counts uncompressed archive data

The documentation described base backup progress in terms of data
streamed, which could be mistaken for the amount of data sent over the
connection when server-side compression is enabled. Clarify that the
counters measure archive data before server-side compression.

The progress report message was also documented as counting bytes from
the current tablespace, although it reports a cumulative count for the
whole backup. Correct the description to say that the count covers all
tablespaces since the backup began.

Backpatch to 15, where both the progress report message and server-side
compression were introduced.

Suggested-by: Surya Poondla <suryapoondla4(at)gmail(dot)com>
Author: Daria Lepikhova <daria(dot)n(dot)lepikhova(at)gmail(dot)com>
Reviewed-by: Surya Poondla <suryapoondla4(at)gmail(dot)com>
Reviewed-by: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Discussion: https://postgr.es/m/CAOVWO5pNe6XprMnt5OTT+-2Sm67z5GX4DzUNArEHubF0z9-PZQ@mail.gmail.com
Backpatch-through: 15

Branch
------
REL_19_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/4a04576caeb4b841879078c7ae57a2ddac9e77e2

Modified Files
--------------
doc/src/sgml/monitoring.sgml | 8 +++++---
doc/src/sgml/protocol.sgml | 11 +++++++----
doc/src/sgml/ref/pg_basebackup.sgml | 4 ++--
src/include/backup/basebackup_sink.h | 8 +++++---
4 files changed, 19 insertions(+), 12 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Fujii Masao 2026-10-14 10:57:53 pgsql: pg_basebackup: Report correct size estimate for incremental back
Previous Message Fujii Masao 2026-10-14 10:57:27 pgsql: doc: Clarify that base backup progress counts uncompressed archi