diff options
| author | David Rowley | 2023-04-16 00:05:34 +0000 |
|---|---|---|
| committer | David Rowley | 2023-04-16 00:05:34 +0000 |
| commit | c0235013c13b0adc9e7f1998ff5700e26ecdbd1f (patch) | |
| tree | 998ba080dcd9c6c6e000038f4094fcea39f2641f /doc/src/sgml/ref/vacuum.sgml | |
| parent | 064eb89e83ea0f59426c92906329f1e6c423dfa4 (diff) | |
Improve VACUUM/ANALYZE BUFFER_USAGE_LIMIT docs
This addresses various deficiencies in the documentation for VACUUM and
ANALYZE's BUFFER_USEAGE_LIMIT docs.
Here we declare "size" in the syntax synopsis for VACUUM and ANALYZE's
BUFFER_USAGE_LIMIT option and then define exactly what values can be
specified for it in the section for that below.
Also, fix the incorrect ordering of vacuumdb options both in the documents
and in vacuumdb's --help output. These should be in alphabetical order.
In passing also add the minimum/maximum range for the BUFFER_USAGE_LIMIT
option. These will also serve as example values that can be modified and
used.
Reported-by: Peter Eisentraut
Discussion: https://postgr.es/m/[email protected]
Diffstat (limited to 'doc/src/sgml/ref/vacuum.sgml')
| -rw-r--r-- | doc/src/sgml/ref/vacuum.sgml | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml index dd0fbb8cb75..57bc4c23ec0 100644 --- a/doc/src/sgml/ref/vacuum.sgml +++ b/doc/src/sgml/ref/vacuum.sgml @@ -39,7 +39,7 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet PARALLEL <replaceable class="parameter">integer</replaceable> SKIP_DATABASE_STATS [ <replaceable class="parameter">boolean</replaceable> ] ONLY_DATABASE_STATS [ <replaceable class="parameter">boolean</replaceable> ] - BUFFER_USAGE_LIMIT [ <replaceable class="parameter">string</replaceable> ] + BUFFER_USAGE_LIMIT [ <replaceable class="parameter">size</replaceable> ] <phrase>and <replaceable class="parameter">table_and_columns</replaceable> is:</phrase> @@ -364,7 +364,8 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet <xref linkend="guc-vacuum-buffer-usage-limit"/>. Higher settings can allow <command>VACUUM</command> to run more quickly, but having too large a setting may cause too many other useful pages to be evicted from - shared buffers. + shared buffers. The minimum value is <literal>128 kB</literal> and the + maximum value is <literal>16 GB</literal>. </para> </listitem> </varlistentry> @@ -393,6 +394,19 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet </varlistentry> <varlistentry> + <term><replaceable class="parameter">size</replaceable></term> + <listitem> + <para> + Specifies an amount of memory in kilobytes. Sizes may also be specified + as a string containing the numerical size followed by any one of the + following memory units: <literal>kB</literal> (kilobytes), + <literal>MB</literal> (megabytes), <literal>GB</literal> (gigabytes), or + <literal>TB</literal> (terabytes). + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><replaceable class="parameter">table_name</replaceable></term> <listitem> <para> |