upstream/postgresql
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2026-06-13 18:50:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Mention online checksum enabling in pg_checksums docs

Browse source 
The documentation for bin/pg_checksums refered to online processing only
in passing, this extends the documentation to list online checksums as as
alternative as well as providing a link to the new Data Checksums section.

Author: Daniel Gustafsson <daniel@yesql.se>
Reviewed-by: Bruce Momjian <bruce@momjian.us>
Reported-by: Bruce Momjian <bruce@momjian.us>
Discussion: https://postgr.es/m/aiHKJWa1k28fFTqf@momjian.us
This commit is contained in:
Daniel Gustafsson 2026-06-05 00:12:33 +02:00
parent 68c8a365d4
commit 4ae3e98c02
2 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/src/sgml/ref/pg_checksums.sgml
View file

@ -38,17 +38,22 @@ PostgreSQL documentation
<para>
<application>pg_checksums</application> checks, enables or disables data
checksums in a <productname>PostgreSQL</productname> cluster. The server
must be shut down cleanly before running
<application>pg_checksums</application>. When verifying checksums, the exit
must be shut down cleanly before running <application>pg_checksums</application>.
Checksums can also be enabled while the cluster is running using
<xref linkend="checksums-online-enable-disable"/> processing, see
<xref linkend="checksums"/> for further details on the different approaches.
When verifying checksums, the exit
status is zero if there are no checksum errors, and nonzero if at least one
checksum failure is detected. When enabling or disabling checksums, the
exit status is nonzero if the operation failed.
</para>
<para>
When enabling checksums, if checksums were in the process of being enabled
when the cluster was shut down, <application>pg_checksums</application>
will still process all relations regardless of the online processing.
When enabling checksums with <application>pg_checksums</application>, if
checksums were in the process of being enabled using
<xref linkend="checksums-online-enable-disable"/> when the cluster was shut
down, <application>pg_checksums</application> will still process all
relation files regardless of the progress of online checksum processing.
</para>
<para>

2
doc/src/sgml/wal.sgml
View file

@ -276,7 +276,7 @@
</sect2>
<sect2 id="checksums-online-enable-disable">
<sect2 id="checksums-online-enable-disable" xreflabel="Online Enabling of Checksums">
<title>Online Enabling of Checksums</title>
<para>