postgres.git / summary / log / commit / refs

commit    a0e7e9799c71abdfdebf16219903e1e2d08687cd
Author:   Amit Kapila <akapila@postgresql.org>
Date:     Wed Jun 25 04:37:03 2025 +0000
First released in: 18.0, 16.10, 17.6

    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 | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 0396d3a9e98..1b1894e9751 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -7052,8 +7052,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
        <term>Int64 (XLogRecPtr)</term>
        <listitem>
         <para>
-         The LSN of the abort. This field is available since protocol version
-         4.
+         The LSN of the abort operation, present only when streaming is set to parallel.
+         This field is available since protocol version 4.
         </para>
        </listitem>
       </varlistentry>
@@ -7062,9 +7062,9 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
        <term>Int64 (TimestampTz)</term>
        <listitem>
         <para>
-         Abort timestamp of the transaction. The value is in number
-         of microseconds since PostgreSQL epoch (2000-01-01). This field is
-         available since protocol version 4.
+         Abort timestamp of the transaction, present only when streaming is set to
+         parallel. The value is in number of microseconds since PostgreSQL epoch (2000-01-01).
+         This field is available since protocol version 4.
         </para>
        </listitem>
       </varlistentry>


[parent: 2e0b5d252b10]