pgsql: Doc: Improve documentation of stream abort. - Mailing list pgsql-committers

From Amit Kapila
Subject pgsql: Doc: Improve documentation of stream abort.
Date
Msg-id E1uUIH6-003EVL-1d@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
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
------
REL_17_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/a0e7e9799c71abdfdebf16219903e1e2d08687cd

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


pgsql-committers by date:

Previous
From: Michael Paquier
Date:
Subject: pgsql: Avoid scribbling of VACUUM options
Next
From: Peter Eisentraut
Date:
Subject: pgsql: pg_createsubscriber: Rename option --remove to --clean