pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Amit Kapila <akapila@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: Doc: Improve documentation of stream abort.
Date: Wed, 25 Jun 2025 05:02:20 +0000
Message-ID: <E1uUIH6-003EVJ-1W@gemulon.postgresql.org> (raw)

Doc: Improve documentation of stream abort.

Protocol v4 introduces parallel streaming, which allows Stream Abort
messages to include additional abort information such as LSN and
timestamp. However, the current documentation only states, "This field is
available since protocol version 4," which may misleadingly suggest that
the fields are always present when using protocol v4.

This patch clarifies that the abort LSN and timestamp are included only
when parallel streaming is enabled, even under protocol v4.

Author: Anthonin Bonnefoy <anthonin.bonnefoy@datadoghq.com>
Reviewed-by: Amit Kapila <amit.kapila16@gmail.com>
Backpatch-through: 16, where it was introduced
Discussion: https://postgr.es/m/CAO6_XqoKteQR1AnaR8iPcegbBE+HkAc2-g12rxN04yOt4-2ORg@mail.gmail.com

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/69e5cdc47fa1fbd97c8b8c7abe6fb0b9a9822acb

Modified Files
--------------
doc/src/sgml/protocol.sgml | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)



view thread (3+ messages)

Message-ID: <E1uUIH6-003EVJ-1W@gemulon.postgresql.org>
Permalink:  ../E1uUIH6-003EVJ-1W@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1uUIH6-003EVJ-1W@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: akapila@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: Doc: Improve documentation of stream abort.
  In-Reply-To: <E1uUIH6-003EVJ-1W@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 DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox