database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-30 11:03:19 +03:00
Code Activity

doc: clarify default checksum behavior in non-master branches

Browse Source 
Also simplify and correct data checksum wording in master now that it is
the default.  PG 13 did not have the awkward wording.

Reported-by: Felix <afripowered@gmail.com>

Reviewed-by: Laurenz Albe

Discussion: https://postgr.es/m/173928241056.707.3989867022954178032@wrigleys.postgresql.org

Backpatch-through: 14
This commit is contained in:
Bruce Momjian
2025-02-21 13:03:29 -05:00
parent 6ea0734e41
commit 901a1cf8b4
4 changed files with 12 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/sgml/amcheck.sgml
View File

@ -466,8 +466,8 @@ SET client_min_messages = DEBUG1;
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
File system or storage subsystem faults where checksums happen to File system or storage subsystem faults when data checksums are
simply not be enabled. disabled.
</para> </para>
<para> <para>
Note that <filename>amcheck</filename> examines a page as represented in some Note that <filename>amcheck</filename> examines a page as represented in some

8
doc/src/sgml/monitoring.sgml
View File

@ -3532,8 +3532,8 @@ description | Waiting for a newly initialized WAL file to reach durable storage
</para> </para>
<para> <para>
Number of data page checksum failures detected in this Number of data page checksum failures detected in this
database (or on a shared object), or NULL if data checksums are not database (or on a shared object), or NULL if data checksums are
enabled. disabled.
</para></entry> </para></entry>
</row> </row>
@ -3543,8 +3543,8 @@ description | Waiting for a newly initialized WAL file to reach durable storage
</para> </para>
<para> <para>
Time at which the last data page checksum failure was detected in Time at which the last data page checksum failure was detected in
this database (or on a shared object), or NULL if data checksums are not this database (or on a shared object), or NULL if data checksums are
enabled. disabled.
</para></entry> </para></entry>
</row> </row>

2
doc/src/sgml/pageinspect.sgml
View File

@ -85,7 +85,7 @@ test=# SELECT * FROM page_header(get_raw_page('pg_class', 0));
<para> <para>
The <structfield>checksum</structfield> field is the checksum stored in The <structfield>checksum</structfield> field is the checksum stored in
the page, which might be incorrect if the page is somehow corrupted. If the page, which might be incorrect if the page is somehow corrupted. If
data checksums are not enabled for this instance, then the value stored data checksums are disabled for this instance, then the value stored
is meaningless. is meaningless.
</para> </para>
</listitem> </listitem>

12
doc/src/sgml/wal.sgml
View File

@ -194,10 +194,8 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Data pages are not currently checksummed by default, though full page images Data pages are checksummed by default, and full page images
recorded in WAL records will be protected; see <link recorded in WAL records are always checksum protected.
linkend="app-initdb-data-checksums"><application>initdb</application></link>
for details about enabling data checksums.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -238,15 +236,15 @@
</indexterm> </indexterm>
<para> <para>
By default, data pages are not protected by checksums, but this can By default, data pages are protected by checksums, but this can
optionally be enabled for a cluster. When enabled, each data page includes optionally be disabled for a cluster. When enabled, each data page includes
a checksum that is updated when the page is written and verified each time a checksum that is updated when the page is written and verified each time
the page is read. Only data pages are protected by checksums; internal data the page is read. Only data pages are protected by checksums; internal data
structures and temporary files are not. structures and temporary files are not.
</para> </para>
<para> <para>
Checksums are normally enabled when the cluster is initialized using <link Checksums can be disabled when the cluster is initialized using <link
linkend="app-initdb-data-checksums"><application>initdb</application></link>. linkend="app-initdb-data-checksums"><application>initdb</application></link>.
They can also be enabled or disabled at a later time as an offline They can also be enabled or disabled at a later time as an offline
operation. Data checksums are enabled or disabled at the full cluster operation. Data checksums are enabled or disabled at the full cluster