Skip to content

Commit 43e592c

Browse files
committed
doc: Move wal_init_zero and wal_recycle descriptions to proper section.
The group of wal_init_zero and wal_recycle is WAL_SETTINGS in guc.c, but previously their documents were located in "Replication"/"Sending Servers" section. This commit moves them to the proper section "Write Ahead Log"/"Settings". Back-patch to v12 where wal_init_zero and wal_recycle parameters were introduced. Author: Fujii Masao Discussion: https://postgr.es/m/b5190ab4-a169-6a42-0e49-aed0807c8976@oss.nttdata.com
1 parent caa3c42 commit 43e592c

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

doc/src/sgml/config.sgml

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2820,6 +2820,41 @@ include_dir 'conf.d'
28202820
</listitem>
28212821
</varlistentry>
28222822

2823+
<varlistentry id="guc-wal-init-zero" xreflabel="wal_init_zero">
2824+
<term><varname>wal_init_zero</varname> (<type>boolean</type>)
2825+
<indexterm>
2826+
<primary><varname>wal_init_zero</varname> configuration parameter</primary>
2827+
</indexterm>
2828+
</term>
2829+
<listitem>
2830+
<para>
2831+
If set to <literal>on</literal> (the default), this option causes new
2832+
WAL files to be filled with zeroes. On some file systems, this ensures
2833+
that space is allocated before we need to write WAL records. However,
2834+
<firstterm>Copy-On-Write</firstterm> (COW) file systems may not benefit
2835+
from this technique, so the option is given to skip the unnecessary
2836+
work. If set to <literal>off</literal>, only the final byte is written
2837+
when the file is created so that it has the expected size.
2838+
</para>
2839+
</listitem>
2840+
</varlistentry>
2841+
2842+
<varlistentry id="guc-wal-recycle" xreflabel="wal_recycle">
2843+
<term><varname>wal_recycle</varname> (<type>boolean</type>)
2844+
<indexterm>
2845+
<primary><varname>wal_recycle</varname> configuration parameter</primary>
2846+
</indexterm>
2847+
</term>
2848+
<listitem>
2849+
<para>
2850+
If set to <literal>on</literal> (the default), this option causes WAL
2851+
files to be recycled by renaming them, avoiding the need to create new
2852+
ones. On COW file systems, it may be faster to create new ones, so the
2853+
option is given to disable this behavior.
2854+
</para>
2855+
</listitem>
2856+
</varlistentry>
2857+
28232858
<varlistentry id="guc-wal-buffers" xreflabel="wal_buffers">
28242859
<term><varname>wal_buffers</varname> (<type>integer</type>)
28252860
<indexterm>
@@ -3752,41 +3787,6 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
37523787
</listitem>
37533788
</varlistentry>
37543789

3755-
<varlistentry id="guc-wal-init-zero" xreflabel="wal_init_zero">
3756-
<term><varname>wal_init_zero</varname> (<type>boolean</type>)
3757-
<indexterm>
3758-
<primary><varname>wal_init_zero</varname> configuration parameter</primary>
3759-
</indexterm>
3760-
</term>
3761-
<listitem>
3762-
<para>
3763-
If set to <literal>on</literal> (the default), this option causes new
3764-
WAL files to be filled with zeroes. On some file systems, this ensures
3765-
that space is allocated before we need to write WAL records. However,
3766-
<firstterm>Copy-On-Write</firstterm> (COW) file systems may not benefit
3767-
from this technique, so the option is given to skip the unnecessary
3768-
work. If set to <literal>off</literal>, only the final byte is written
3769-
when the file is created so that it has the expected size.
3770-
</para>
3771-
</listitem>
3772-
</varlistentry>
3773-
3774-
<varlistentry id="guc-wal-recycle" xreflabel="wal_recycle">
3775-
<term><varname>wal_recycle</varname> (<type>boolean</type>)
3776-
<indexterm>
3777-
<primary><varname>wal_recycle</varname> configuration parameter</primary>
3778-
</indexterm>
3779-
</term>
3780-
<listitem>
3781-
<para>
3782-
If set to <literal>on</literal> (the default), this option causes WAL
3783-
files to be recycled by renaming them, avoiding the need to create new
3784-
ones. On COW file systems, it may be faster to create new ones, so the
3785-
option is given to disable this behavior.
3786-
</para>
3787-
</listitem>
3788-
</varlistentry>
3789-
37903790
<varlistentry id="guc-max-slot-wal-keep-size" xreflabel="max_slot_wal_keep_size">
37913791
<term><varname>max_slot_wal_keep_size</varname> (<type>integer</type>)
37923792
<indexterm>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy