]> git.ipfire.org Git - thirdparty/postgresql.git/commit
Doc: Improve documentation of stream abort.
authorAmit Kapila <akapila@postgresql.org>
Wed, 25 Jun 2025 04:48:22 +0000 (10:18 +0530)
committerAmit Kapila <akapila@postgresql.org>
Wed, 25 Jun 2025 04:48:22 +0000 (10:18 +0530)
commita4a1f9ec0aac2714ae9dad765b6259fb9b74e1e1
treefecff902a707e88181dbe352292ea0b370b75c70
parentd187cabddadcbea2033d172e738edbd65b5a3f8d
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
doc/src/sgml/protocol.sgml