doc: Fix documenation for snapshot export in logical decoding.
authorFujii Masao <[email protected]>
Mon, 26 May 2025 03:50:01 +0000 (12:50 +0900)
committerFujii Masao <[email protected]>
Mon, 26 May 2025 03:50:01 +0000 (12:50 +0900)
The documentation for exported snapshots in logical decoding previously
stated that snapshot creation may fail on a hot standby. This is no longer
accurate, as snapshot exporting on standbys has been supported since
PostgreSQL 10. This commit removes the outdated description.

Additionally, the docs referred to the NOEXPORT_SNAPSHOT option to
suppress snapshot exporting in CREATE_REPLICATION_SLOT. However,
since PostgreSQL 15, NOEXPORT_SNAPSHOT is considered legacy syntax
and retained only for backward compatibility. This commit updates
the documentation for v15 and later to use the modern equivalent:
SNAPSHOT 'nothing'. The older syntax is preserved in documentation for
v14 and earlier.

Back-patched to all supported branches.

Reported-by: Kevin K Biju <[email protected]>
Author: Fujii Masao <[email protected]>
Reviewed-by: Kevin K Biju <[email protected]>
Discussion: https://postgr.es/m/174791480466.798.17122832105389395178@wrigleys.postgresql.org
Backpatch-through: 13

doc/src/sgml/logicaldecoding.sgml

index 7805dd44a18ff0a84999a06367e45259846f0fdb..847d7de723a2a6e23613c599045ee7376706b5c8 100644 (file)
@@ -335,8 +335,7 @@ postgres=# select * from pg_logical_slot_get_changes('regression_slot', NULL, NU
      using the slot's contents without losing any changes.
     </para>
     <para>
-     Creation of a snapshot is not always possible.  In particular, it will
-     fail when connected to a hot standby.  Applications that do not require
+     Applications that do not require
      snapshot export may suppress it with the <literal>NOEXPORT_SNAPSHOT</literal>
      option.
     </para>