Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 99ae342

Browse files
author
Amit Kapila
committed
Change the docs for PARALLEL option of Vacuum.
The rules to choose the number of parallel workers to perform parallel vacuum operation were not clearly specified. Reported-by: Peter Eisentraut Author: Amit Kapila Backpatch-through: 13, where it was introduced Discussion: https://postgr.es/m/36aa8aea-61b7-eb3c-263b-648e0cb117b7@2ndquadrant.com
1 parent 1bd9b2b commit 99ae342

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

doc/src/sgml/ref/vacuum.sgml

+16-16
Original file line numberDiff line numberDiff line change
@@ -235,22 +235,22 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet
235235
Perform index vacuum and index cleanup phases of <command>VACUUM</command>
236236
in parallel using <replaceable class="parameter">integer</replaceable>
237237
background workers (for the details of each vacuum phase, please
238-
refer to <xref linkend="vacuum-phases"/>). In plain <command>VACUUM</command>
239-
(without <literal>FULL</literal>), if the <literal>PARALLEL</literal> option
240-
is omitted, then the number of workers is determined based on the number of
241-
indexes on the relation that support parallel vacuum operation and is further
242-
limited by <xref linkend="guc-max-parallel-workers-maintenance"/>. An index
243-
can participate in parallel vacuum if and only if the size of the index is
244-
more than <xref linkend="guc-min-parallel-index-scan-size"/>. Please note
245-
that it is not guaranteed that the number of parallel workers specified in
246-
<replaceable class="parameter">integer</replaceable> will be used during
247-
execution. It is possible for a vacuum to run with fewer workers than
248-
specified, or even with no workers at all. Only one worker can be used per
249-
index. So parallel workers are launched only when there are at least
250-
<literal>2</literal> indexes in the table. Workers for vacuum are launched
251-
before the start of each phase and exit at the end of the phase. These
252-
behaviors might change in a future release. This option can't be used with
253-
the <literal>FULL</literal> option.
238+
refer to <xref linkend="vacuum-phases"/>). The number of workers used
239+
to perform the operation is equal to the number of indexes on the
240+
relation that support parallel vacuum which is limited by the number of
241+
workers specified with <literal>PARALLEL</literal> option if any which is
242+
further limited by <xref linkend="guc-max-parallel-maintenance-workers"/>.
243+
An index can participate in parallel vacuum if and only if the size of the
244+
index is more than <xref linkend="guc-min-parallel-index-scan-size"/>.
245+
Please note that it is not guaranteed that the number of parallel workers
246+
specified in <replaceable class="parameter">integer</replaceable> will be
247+
used during execution. It is possible for a vacuum to run with fewer
248+
workers than specified, or even with no workers at all. Only one worker
249+
can be used per index. So parallel workers are launched only when there
250+
are at least <literal>2</literal> indexes in the table. Workers for
251+
vacuum are launched before the start of each phase and exit at the end of
252+
the phase. These behaviors might change in a future release. This
253+
option can't be used with the <literal>FULL</literal> option.
254254
</para>
255255
</listitem>
256256
</varlistentry>

0 commit comments

Comments
 (0)