From 8c7f0613458f6090021a0d20767c692b98f0654a Mon Sep 17 00:00:00 2001 From: Nathan Bossart Date: Wed, 27 Jan 2021 23:09:44 +0000 Subject: [PATCH v6 1/1] Add TOAST_TABLE_CLEANUP option to VACUUM. --- doc/src/sgml/ref/vacuum.sgml | 15 +++++++++++++++ doc/src/sgml/ref/vacuumdb.sgml | 15 +++++++++++++++ src/backend/commands/vacuum.c | 17 +++++++++++++++-- src/bin/psql/tab-complete.c | 5 +++-- src/bin/scripts/t/100_vacuumdb.pl | 9 ++++++++- src/bin/scripts/vacuumdb.c | 28 ++++++++++++++++++++++++++++ src/test/regress/expected/vacuum.out | 6 ++++++ src/test/regress/sql/vacuum.sql | 6 ++++++ 8 files changed, 96 insertions(+), 5 deletions(-) diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml index 21ab57d880..d4d7935850 100644 --- a/doc/src/sgml/ref/vacuum.sgml +++ b/doc/src/sgml/ref/vacuum.sgml @@ -33,6 +33,7 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ boolean ] SKIP_LOCKED [ boolean ] INDEX_CLEANUP [ boolean ] + TOAST_TABLE_CLEANUP [ boolean ] TRUNCATE [ boolean ] PARALLEL integer @@ -210,6 +211,20 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ defname, "toast_table_cleanup") == 0) + toast_cleanup = defGetBoolean(opt); else if (strcmp(opt->defname, "truncate") == 0) params.truncate = get_vacopt_ternary_value(opt); else if (strcmp(opt->defname, "parallel") == 0) @@ -189,13 +192,13 @@ ExecVacuum(ParseState *pstate, VacuumStmt *vacstmt, bool isTopLevel) (analyze ? VACOPT_ANALYZE : 0) | (freeze ? VACOPT_FREEZE : 0) | (full ? VACOPT_FULL : 0) | - (disable_page_skipping ? VACOPT_DISABLE_PAGE_SKIPPING : 0); + (disable_page_skipping ? VACOPT_DISABLE_PAGE_SKIPPING : 0) | + (toast_cleanup ? 0 : VACOPT_SKIPTOAST); /* sanity checks on options */ Assert(params.options & (VACOPT_VACUUM | VACOPT_ANALYZE)); Assert((params.options & VACOPT_VACUUM) || !(params.options & (VACOPT_FULL | VACOPT_FREEZE))); - Assert(!(params.options & VACOPT_SKIPTOAST)); if ((params.options & VACOPT_FULL) && params.nworkers > 0) ereport(ERROR, @@ -318,6 +321,16 @@ vacuum(List *relations, VacuumParams *params, (errcode(ERRCODE_FEATURE_NOT_SUPPORTED), errmsg("VACUUM option DISABLE_PAGE_SKIPPING cannot be used with FULL"))); + /* + * Sanity check TOAST_TABLE_CLEANUP option. + */ + if ((params->options & VACOPT_FULL) != 0 && + (params->options & VACOPT_SKIPTOAST) != 0) + ereport(ERROR, + (errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("VACUUM option TOAST_TABLE_CLEANUP cannot be " + "disabled when FULL is used"))); + /* * Send info about dead objects to the statistics collector, unless we are * in autovacuum --- autovacuum.c does this for itself. diff --git a/src/bin/psql/tab-complete.c b/src/bin/psql/tab-complete.c index 17f7265038..f40e5e7c68 100644 --- a/src/bin/psql/tab-complete.c +++ b/src/bin/psql/tab-complete.c @@ -3868,8 +3868,9 @@ psql_completion(const char *text, int start, int end) if (ends_with(prev_wd, '(') || ends_with(prev_wd, ',')) COMPLETE_WITH("FULL", "FREEZE", "ANALYZE", "VERBOSE", "DISABLE_PAGE_SKIPPING", "SKIP_LOCKED", - "INDEX_CLEANUP", "TRUNCATE", "PARALLEL"); - else if (TailMatches("FULL|FREEZE|ANALYZE|VERBOSE|DISABLE_PAGE_SKIPPING|SKIP_LOCKED|INDEX_CLEANUP|TRUNCATE")) + "INDEX_CLEANUP", "TRUNCATE", "PARALLEL", + "TOAST_TABLE_CLEANUP"); + else if (TailMatches("FULL|FREEZE|ANALYZE|VERBOSE|DISABLE_PAGE_SKIPPING|SKIP_LOCKED|INDEX_CLEANUP|TRUNCATE|TOAST_TABLE_CLEANUP")) COMPLETE_WITH("ON", "OFF"); } else if (HeadMatches("VACUUM") && TailMatches("(")) diff --git a/src/bin/scripts/t/100_vacuumdb.pl b/src/bin/scripts/t/100_vacuumdb.pl index 9e36b6d2b0..613f6fb0d2 100644 --- a/src/bin/scripts/t/100_vacuumdb.pl +++ b/src/bin/scripts/t/100_vacuumdb.pl @@ -3,7 +3,7 @@ use warnings; use PostgresNode; use TestLib; -use Test::More tests => 55; +use Test::More tests => 58; program_help_ok('vacuumdb'); program_version_ok('vacuumdb'); @@ -62,6 +62,13 @@ $node->issues_sql_like( $node->command_fails( [ 'vacuumdb', '--analyze-only', '--no-truncate', 'postgres' ], '--analyze-only and --no-truncate specified together'); +$node->issues_sql_like( + [ 'vacuumdb', '--no-toast-table-cleanup', 'postgres' ], + qr/statement: VACUUM \(TOAST_TABLE_CLEANUP FALSE\).*;/, + 'vacuumdb --no-toast-table-cleanup'); +$node->command_fails( + [ 'vacuumdb', '--analyze-only', '--no-toast-table-cleanup', 'postgres' ], + '--analyze-only and --no-toast-table-cleanup specified together'); $node->issues_sql_like( [ 'vacuumdb', '-P', 2, 'postgres' ], qr/statement: VACUUM \(PARALLEL 2\).*;/, diff --git a/src/bin/scripts/vacuumdb.c b/src/bin/scripts/vacuumdb.c index 8246327770..a76d637b07 100644 --- a/src/bin/scripts/vacuumdb.c +++ b/src/bin/scripts/vacuumdb.c @@ -39,6 +39,7 @@ typedef struct vacuumingOptions * parallel degree, otherwise -1 */ bool do_index_cleanup; bool do_truncate; + bool do_toast_table_cleanup; } vacuumingOptions; @@ -97,6 +98,7 @@ main(int argc, char *argv[]) {"min-mxid-age", required_argument, NULL, 7}, {"no-index-cleanup", no_argument, NULL, 8}, {"no-truncate", no_argument, NULL, 9}, + {"no-toast-table-cleanup", no_argument, NULL, 10}, {NULL, 0, NULL, 0} }; @@ -124,6 +126,7 @@ main(int argc, char *argv[]) vacopts.parallel_workers = -1; vacopts.do_index_cleanup = true; vacopts.do_truncate = true; + vacopts.do_toast_table_cleanup = true; pg_logging_init(argv[0]); progname = get_progname(argv[0]); @@ -233,6 +236,9 @@ main(int argc, char *argv[]) case 9: vacopts.do_truncate = false; break; + case 10: + vacopts.do_toast_table_cleanup = false; + break; default: fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname); exit(1); @@ -289,6 +295,12 @@ main(int argc, char *argv[]) "no-truncate"); exit(1); } + if (!vacopts.do_toast_table_cleanup) + { + pg_log_error("cannot use the \"%s\" option when performing only analyze", + "no-toast-table-cleanup"); + exit(1); + } /* allow 'and_analyze' with 'analyze_only' */ } @@ -454,6 +466,14 @@ vacuum_one_database(const ConnParams *cparams, exit(1); } + if (!vacopts->do_toast_table_cleanup && PQserverVersion(conn) < 140000) + { + PQfinish(conn); + pg_log_error("cannot use the \"%s\" option on server versions older than PostgreSQL %s", + "no-toast-table-cleanup", "14"); + exit(1); + } + if (vacopts->skip_locked && PQserverVersion(conn) < 120000) { PQfinish(conn); @@ -869,6 +889,13 @@ prepare_vacuum_command(PQExpBuffer sql, int serverVersion, appendPQExpBuffer(sql, "%sTRUNCATE FALSE", sep); sep = comma; } + if (!vacopts->do_toast_table_cleanup) + { + /* TOAST_TABLE_CLEANUP is supported since v14 */ + Assert(serverVersion >= 140000); + appendPQExpBuffer(sql, "%sTOAST_TABLE_CLEANUP FALSE", sep); + sep = comma; + } if (vacopts->skip_locked) { /* SKIP_LOCKED is supported since v12 */ @@ -968,6 +995,7 @@ help(const char *progname) printf(_(" --min-mxid-age=MXID_AGE minimum multixact ID age of tables to vacuum\n")); printf(_(" --min-xid-age=XID_AGE minimum transaction ID age of tables to vacuum\n")); printf(_(" --no-index-cleanup don't remove index entries that point to dead tuples\n")); + printf(_(" --no-toast-table-cleanup don't clean up the TOAST table\n")); printf(_(" --no-truncate don't truncate empty pages at the end of the table\n")); printf(_(" -P, --parallel=PARALLEL_DEGREE use this many background workers for vacuum, if available\n")); printf(_(" -q, --quiet don't write any messages\n")); diff --git a/src/test/regress/expected/vacuum.out b/src/test/regress/expected/vacuum.out index 3fccb183c0..6f4736d3df 100644 --- a/src/test/regress/expected/vacuum.out +++ b/src/test/regress/expected/vacuum.out @@ -252,6 +252,12 @@ RESET default_transaction_isolation; BEGIN TRANSACTION ISOLATION LEVEL SERIALIZABLE; ANALYZE vactst; COMMIT; +-- TOAST_TABLE_CLEANUP option +ALTER TABLE vactst ADD COLUMN t TEXT; +ALTER TABLE vactst ALTER COLUMN t SET STORAGE EXTERNAL; +VACUUM (TOAST_TABLE_CLEANUP FALSE) vactst; +VACUUM (TOAST_TABLE_CLEANUP FALSE, FULL) vactst; +ERROR: VACUUM option TOAST_TABLE_CLEANUP cannot be disabled when FULL is used DROP TABLE vaccluster; DROP TABLE vactst; DROP TABLE vacparted; diff --git a/src/test/regress/sql/vacuum.sql b/src/test/regress/sql/vacuum.sql index c7b5f96f6b..d8516903c0 100644 --- a/src/test/regress/sql/vacuum.sql +++ b/src/test/regress/sql/vacuum.sql @@ -213,6 +213,12 @@ BEGIN TRANSACTION ISOLATION LEVEL SERIALIZABLE; ANALYZE vactst; COMMIT; +-- TOAST_TABLE_CLEANUP option +ALTER TABLE vactst ADD COLUMN t TEXT; +ALTER TABLE vactst ALTER COLUMN t SET STORAGE EXTERNAL; +VACUUM (TOAST_TABLE_CLEANUP FALSE) vactst; +VACUUM (TOAST_TABLE_CLEANUP FALSE, FULL) vactst; + DROP TABLE vaccluster; DROP TABLE vactst; DROP TABLE vacparted; -- 2.16.6