agora inbox for pgsql-committers@postgresql.org  
help / color / mirror / Atom feed
From: Fujii Masao <fujii@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: doc: Improve pg_stat_recovery documentation
Date: Thu, 23 Jul 2026 10:27:29 +0000
Message-ID: <E1wmqeH-00000000QIt-343j@gemulon.postgresql.org> (raw)

doc: Improve pg_stat_recovery documentation

Improve the documentation for pg_stat_recovery in several ways:

- Mention the view in high-availability.sgml as a way to monitor
  recovery state and replay progress, alongside the existing recovery
  information functions.
- Clarify that the view returns at most one row, not exactly one row,
  and no rows to users who lack the pg_read_all_stats privilege.
- Correct the description of last_replayed_end_lsn to clarify that it
  is the end LSN of the last replayed record plus one.
- Document that replay_end_tli equals last_replayed_tli when no WAL
  record is currently being replayed.
- Clarify that current_chunk_start_time is NULL until streaming WAL
  has been received.

Backpatch to v19, where pg_stat_recovery was introduced.

Author: Fujii Masao <masao.fujii@gmail.com>
Reviewed-by: Michael Paquier <michael@paquier.xyz>
Discussion: https://postgr.es/m/CAHGQGwGRavm18HqnQn_f68QB96qk6arhjET1V93OJH09Mgojkg@mail.gmail.com
Backpatch-through: 19

Branch
------
REL_19_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/42b480d286828f94e476ab45a752321602b12c75

Modified Files
--------------
doc/src/sgml/high-availability.sgml | 13 +++++++++----
doc/src/sgml/monitoring.sgml        | 33 +++++++++++++++++++--------------
src/include/access/xlogrecovery.h   |  4 ++--
3 files changed, 30 insertions(+), 20 deletions(-)



view thread (2+ messages)

Message-ID: <E1wmqeH-00000000QIt-343j@gemulon.postgresql.org>
Permalink:  ../E1wmqeH-00000000QIt-343j@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1wmqeH-00000000QIt-343j@gemulon.postgresql.org

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-committers@postgresql.org
  Cc: fujii@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: doc: Improve pg_stat_recovery documentation
  In-Reply-To: <E1wmqeH-00000000QIt-343j@gemulon.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox