Skip to content

Commit 69e5cdc

Browse files
author
Amit Kapila
committed
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
1 parent 661643d commit 69e5cdc

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/src/sgml/protocol.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7292,8 +7292,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
72927292
<term>Int64 (XLogRecPtr)</term>
72937293
<listitem>
72947294
<para>
7295-
The LSN of the abort. This field is available since protocol version
7296-
4.
7295+
The LSN of the abort operation, present only when streaming is set to parallel.
7296+
This field is available since protocol version 4.
72977297
</para>
72987298
</listitem>
72997299
</varlistentry>
@@ -7302,9 +7302,9 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
73027302
<term>Int64 (TimestampTz)</term>
73037303
<listitem>
73047304
<para>
7305-
Abort timestamp of the transaction. The value is in number
7306-
of microseconds since PostgreSQL epoch (2000-01-01). This field is
7307-
available since protocol version 4.
7305+
Abort timestamp of the transaction, present only when streaming is set to
7306+
parallel. The value is in number of microseconds since PostgreSQL epoch (2000-01-01).
7307+
This field is available since protocol version 4.
73087308
</para>
73097309
</listitem>
73107310
</varlistentry>

0 commit comments

Comments
 (0)