Documentation for min_wal_size and max_wal_size
Started by Albe Laurenzabout 10 years ago2 messages
Wouldn't it be better to have these two parameters documented next to each other,
as in the attached patch?
Yours,
Laurenz Albe
Attachments:
0001-Move-documentation-for-min_wal_size-before-max_wal_s.patchapplication/octet-stream; name=0001-Move-documentation-for-min_wal_size-before-max_wal_s.patchDownload
From 383018fcd67b2a9cbefefa5a12b47b7fe74a59ba Mon Sep 17 00:00:00 2001
From: Laurenz Albe <laurenz.albe@wien.gv.at>
Date: Tue, 20 Oct 2015 16:21:47 +0200
Subject: [PATCH] Move documentation for min_wal_size before max_wal_size
---
doc/src/sgml/config.sgml | 38 +++++++++++++++++++-------------------
1 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 5081da0..f2ac3d4 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -2417,6 +2417,25 @@ include_dir 'conf.d'
<title>Checkpoints</title>
<variablelist>
+ <varlistentry id="guc-min-wal-size" xreflabel="min_wal_size">
+ <term><varname>min_wal_size</varname> (<type>integer</type>)
+ <indexterm>
+ <primary><varname>min_wal_size</> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ As long as WAL disk usage stays below this setting, old WAL files are
+ always recycled for future use at a checkpoint, rather than removed.
+ This can be used to ensure that enough WAL space is reserved to
+ handle spikes in WAL usage, for example when running large batch
+ jobs. The default is 80 MB.
+ This parameter can only be set in the <filename>postgresql.conf</>
+ file or on the server command line.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry id="guc-max-wal-size" xreflabel="max_wal_size">
<term><varname>max_wal_size</varname> (<type>integer</type>)
<indexterm>
@@ -2494,25 +2513,6 @@ include_dir 'conf.d'
</listitem>
</varlistentry>
- <varlistentry id="guc-min-wal-size" xreflabel="min_wal_size">
- <term><varname>min_wal_size</varname> (<type>integer</type>)
- <indexterm>
- <primary><varname>min_wal_size</> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- As long as WAL disk usage stays below this setting, old WAL files are
- always recycled for future use at a checkpoint, rather than removed.
- This can be used to ensure that enough WAL space is reserved to
- handle spikes in WAL usage, for example when running large batch
- jobs. The default is 80 MB.
- This parameter can only be set in the <filename>postgresql.conf</>
- file or on the server command line.
- </para>
- </listitem>
- </varlistentry>
-
</variablelist>
</sect2>
<sect2 id="runtime-config-wal-archiving">
--
1.7.1
Re: Documentation for min_wal_size and max_wal_size
On 10/20/15 10:27 AM, Albe Laurenz wrote:
Wouldn't it be better to have these two parameters documented next to each other,
as in the attached patch?
I was also about to fix that. I did it slightly differently, to restore
the original alphabetical ordering.
--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers