Doc: Improve documentation of stream abort.
authorAmit Kapila <[email protected]>
Wed, 25 Jun 2025 04:55:15 +0000 (10:25 +0530)
committerAmit Kapila <[email protected]>
Wed, 25 Jun 2025 04:55:15 +0000 (10:25 +0530)
commit69e5cdc47fa1fbd97c8b8c7abe6fb0b9a9822acb
tree5145d4a30cf4533de897bfad5e1d39f2b6f4e72c
parent661643dedad97f8b924991fdc739b1f47b0fb60b
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 <[email protected]>
Reviewed-by: Amit Kapila <[email protected]>
Backpatch-through: 16, where it was introduced
Discussion: https://postgr.es/m/CAO6_XqoKteQR1AnaR8iPcegbBE+HkAc2-g12rxN04yOt4-2ORg@mail.gmail.com
doc/src/sgml/protocol.sgml