diff options
| author | Michael Paquier | 2023-03-06 07:41:05 +0000 |
|---|---|---|
| committer | Michael Paquier | 2023-03-06 07:41:05 +0000 |
| commit | 4211fbd8413b26e0abedbe4338aa7cda2cd469b4 (patch) | |
| tree | 0c8ac21d9f1a3c83463e79da5e104153741c86e4 /doc/src/sgml/ref/vacuum.sgml | |
| parent | 46d490ac19a7ca93a5c0f47e5a0e759b5385a8ae (diff) | |
Add PROCESS_MAIN to VACUUM
Disabling this option is useful to run VACUUM (with or without FULL) on
only the toast table of a relation, bypassing the main relation. This
option is enabled by default.
Running directly VACUUM on a toast table was already possible without
this feature, by using the non-deterministic name of a toast relation
(as of pg_toast.pg_toast_N, where N would be the OID of the parent
relation) in the VACUUM command, and it required a scan of pg_class to
know the name of the toast table. So this feature is basically a
shortcut to be able to run VACUUM or VACUUM FULL on a toast relation,
using only the name of the parent relation.
A new switch called --no-process-main is added to vacuumdb, to work as
an equivalent of PROCESS_MAIN.
Regression tests are added to cover VACUUM and VACUUM FULL, looking at
pg_stat_all_tables.vacuum_count to see how many vacuums have run on
each table, main or toast.
Author: Nathan Bossart
Reviewed-by: Masahiko Sawada
Discussion: https://postgr.es/m/20221230000028.GA435655@nathanxps13
Diffstat (limited to 'doc/src/sgml/ref/vacuum.sgml')
| -rw-r--r-- | doc/src/sgml/ref/vacuum.sgml | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml index 545b23b54f6..b6d30b57648 100644 --- a/doc/src/sgml/ref/vacuum.sgml +++ b/doc/src/sgml/ref/vacuum.sgml @@ -33,6 +33,7 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet DISABLE_PAGE_SKIPPING [ <replaceable class="parameter">boolean</replaceable> ] SKIP_LOCKED [ <replaceable class="parameter">boolean</replaceable> ] INDEX_CLEANUP { AUTO | ON | OFF } + PROCESS_MAIN [ <replaceable class="parameter">boolean</replaceable> ] PROCESS_TOAST [ <replaceable class="parameter">boolean</replaceable> ] TRUNCATE [ <replaceable class="parameter">boolean</replaceable> ] PARALLEL <replaceable class="parameter">integer</replaceable> @@ -239,6 +240,18 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet </varlistentry> <varlistentry> + <term><literal>PROCESS_MAIN</literal></term> + <listitem> + <para> + Specifies that <command>VACUUM</command> should attempt to process the + main relation. This is usually the desired behavior and is the default. + Setting this option to false may be useful when it is only necessary to + vacuum a relation's corresponding <literal>TOAST</literal> table. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><literal>PROCESS_TOAST</literal></term> <listitem> <para> |