diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index 956c0f01cbc..841aced3bd5 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -39,6 +39,40 @@ PostgreSQL documentation dbname + + vacuumdb + connection-option + option + + + + + + + + + + + schema + + + + + + + + + + schema + + + + + + + dbname + + vacuumdb connection-option @@ -244,6 +278,30 @@ PostgreSQL documentation + + + + + + Clean or analyze all tables in + schema only. Multiple + schemas can be vacuumed by writing multiple switches. + + + + + + + + + + Do not clean or analyze any tables in + schema. Multiple schemas + can be excluded by writing multiple switches. + + + + @@ -619,6 +677,14 @@ PostgreSQL documentation $ vacuumdb --analyze --verbose --table='foo(bar)' xyzzy + + To clean all tables in the foo and bar schemas + in a database named xyzzy: + +$ vacuumdb --schema='foo' --schema='bar' xyzzy + + + diff --git a/src/bin/scripts/t/100_vacuumdb.pl b/src/bin/scripts/t/100_vacuumdb.pl index 96a818a3c16..e5343774fea 100644 --- a/src/bin/scripts/t/100_vacuumdb.pl +++ b/src/bin/scripts/t/100_vacuumdb.pl @@ -103,6 +103,8 @@ $node->safe_psql( CREATE TABLE funcidx (x int); INSERT INTO funcidx VALUES (0),(1),(2),(3); CREATE INDEX i0 ON funcidx ((f1(x))); + CREATE SCHEMA "Foo"; + CREATE TABLE "Foo".bar(id int); |); $node->command_ok([qw|vacuumdb -Z --table="need""q(uot"(")x") postgres|], 'column list'); @@ -146,5 +148,45 @@ $node->issues_sql_like( [ 'vacuumdb', '--min-xid-age', '2147483001', 'postgres' ], qr/GREATEST.*relfrozenxid.*2147483001/, 'vacuumdb --table --min-xid-age'); +$node->issues_sql_like( + [ 'vacuumdb', '--schema', '"Foo"', 'postgres' ], + qr/VACUUM "Foo".bar/, + 'vacuumdb --schema'); +$node->issues_sql_like( + [ 'vacuumdb', '--exclude-schema', '"Foo"', 'postgres' ], + qr/(?:(?!VACUUM "Foo".bar).)*/, + 'vacuumdb --exclude-schema'); +$node->command_fails_like( + [ 'vacuumdb', '-N', 'pg_catalog', '-t', 'pg_class', 'postgres', ], + qr/cannot vacuum specific table\(s\) and exclude schema\(s\) at the same time/, + 'cannot use options -N and -t at the same time'); +$node->command_fails_like( + [ 'vacuumdb', '-n', 'pg_catalog', '-t', 'pg_class', 'postgres' ], + qr/cannot vacuum all tables in schema\(s\) and specific table\(s\) at the same time/, + 'cannot use options -n and -t at the same time'); +$node->command_fails_like( + [ 'vacuumdb', '-n', 'pg_catalog', '-N', '"Foo"', 'postgres' ], + qr/cannot vacuum all tables in schema\(s\) and exclude schema\(s\) at the same time/, + 'cannot use options -n and -N at the same time'); +$node->command_fails_like( + [ 'vacuumdb', '-a', '-N', '"Foo"' ], + qr/cannot exclude specific schema\(s\) in all databases/, + 'cannot use options -a and -N at the same time'); +$node->command_fails_like( + [ 'vacuumdb', '-a', '-n', '"Foo"' ], + qr/cannot vacuum specific schema\(s\) in all databases/, + 'cannot use options -a and -n at the same time'); +$node->command_fails_like( + [ 'vacuumdb', '-a', '-t', '"Foo".bar' ], + qr/cannot vacuum specific table\(s\) in all databases/, + 'cannot use options -a and -t at the same time'); +$node->command_fails_like( + [ 'vacuumdb', '-a', '-d', 'postgres' ], + qr/cannot vacuum all databases and a specific one at the same time/, + 'cannot use options -a and -d at the same time'); +$node->command_fails_like( + [ 'vacuumdb', '-a', 'postgres' ], + qr/cannot vacuum all databases and a specific one at the same time/, + 'cannot use option -a and a dbname as argument at the same time'); done_testing(); diff --git a/src/bin/scripts/vacuumdb.c b/src/bin/scripts/vacuumdb.c index 92f1ffe1479..0482aa9e885 100644 --- a/src/bin/scripts/vacuumdb.c +++ b/src/bin/scripts/vacuumdb.c @@ -46,11 +46,23 @@ typedef struct vacuumingOptions bool process_toast; } vacuumingOptions; +/* object filter options */ +typedef enum +{ + OBJFILTER_NONE = 0, /* no filter used */ + OBJFILTER_ALL_DBS = (1 << 0), /* -a | --all */ + OBJFILTER_DATABASE = (1 << 1), /* -d | --dbname */ + OBJFILTER_TABLE = (1 << 2), /* -t | --table */ + OBJFILTER_SCHEMA = (1 << 3), /* -n | --schema */ + OBJFILTER_SCHEMA_EXCLUDE = (1 << 4) /* -N | --exclude-schema */ +} VacObjFilter; + +VacObjFilter objfilter = OBJFILTER_NONE; static void vacuum_one_database(ConnParams *cparams, vacuumingOptions *vacopts, int stage, - SimpleStringList *tables, + SimpleStringList *objects, int concurrentCons, const char *progname, bool echo, bool quiet); @@ -68,6 +80,8 @@ static void run_vacuum_command(PGconn *conn, const char *sql, bool echo, static void help(const char *progname); +void check_objfilter(void); + /* For analyze-in-stages mode */ #define ANALYZE_NO_STAGE -1 #define ANALYZE_NUM_STAGES 3 @@ -94,6 +108,8 @@ main(int argc, char *argv[]) {"verbose", no_argument, NULL, 'v'}, {"jobs", required_argument, NULL, 'j'}, {"parallel", required_argument, NULL, 'P'}, + {"schema", required_argument, NULL, 'n'}, + {"exclude-schema", required_argument, NULL, 'N'}, {"maintenance-db", required_argument, NULL, 2}, {"analyze-in-stages", no_argument, NULL, 3}, {"disable-page-skipping", no_argument, NULL, 4}, @@ -121,8 +137,7 @@ main(int argc, char *argv[]) bool quiet = false; vacuumingOptions vacopts; bool analyze_in_stages = false; - bool alldb = false; - SimpleStringList tables = {NULL, NULL}; + SimpleStringList objects = {NULL, NULL}; int concurrentCons = 1; int tbl_count = 0; @@ -140,7 +155,7 @@ main(int argc, char *argv[]) handle_help_version_opts(argc, argv, "vacuumdb", help); - while ((c = getopt_long(argc, argv, "h:p:U:wWeqd:zZFat:fvj:P:", long_options, &optindex)) != -1) + while ((c = getopt_long(argc, argv, "h:p:U:wWeqd:zZFat:fvj:P:n:N:", long_options, &optindex)) != -1) { switch (c) { @@ -166,6 +181,7 @@ main(int argc, char *argv[]) quiet = true; break; case 'd': + objfilter |= OBJFILTER_DATABASE; dbname = pg_strdup(optarg); break; case 'z': @@ -178,11 +194,12 @@ main(int argc, char *argv[]) vacopts.freeze = true; break; case 'a': - alldb = true; + objfilter |= OBJFILTER_ALL_DBS; break; case 't': { - simple_string_list_append(&tables, optarg); + objfilter |= OBJFILTER_TABLE; + simple_string_list_append(&objects, optarg); tbl_count++; break; } @@ -202,6 +219,18 @@ main(int argc, char *argv[]) &vacopts.parallel_workers)) exit(1); break; + case 'n': + { + objfilter |= OBJFILTER_SCHEMA; + simple_string_list_append(&objects, optarg); + break; + } + case 'N': + { + objfilter |= OBJFILTER_SCHEMA_EXCLUDE; + simple_string_list_append(&objects, optarg); + break; + } case 2: maintenance_db = pg_strdup(optarg); break; @@ -249,6 +278,7 @@ main(int argc, char *argv[]) */ if (optind < argc && dbname == NULL) { + objfilter |= OBJFILTER_DATABASE; dbname = argv[optind]; optind++; } @@ -261,6 +291,12 @@ main(int argc, char *argv[]) exit(1); } + /* + * Validate the combination of filters specified in the command-line + * options. + */ + check_objfilter(); + if (vacopts.analyze_only) { if (vacopts.full) @@ -316,13 +352,8 @@ main(int argc, char *argv[]) if (tbl_count && (concurrentCons > tbl_count)) concurrentCons = tbl_count; - if (alldb) + if (objfilter & OBJFILTER_ALL_DBS) { - if (dbname) - pg_fatal("cannot vacuum all databases and a specific one at the same time"); - if (tables.head != NULL) - pg_fatal("cannot vacuum specific table(s) in all databases"); - cparams.dbname = maintenance_db; vacuum_all_databases(&cparams, &vacopts, @@ -352,7 +383,7 @@ main(int argc, char *argv[]) { vacuum_one_database(&cparams, &vacopts, stage, - &tables, + &objects, concurrentCons, progname, echo, quiet); } @@ -360,7 +391,7 @@ main(int argc, char *argv[]) else vacuum_one_database(&cparams, &vacopts, ANALYZE_NO_STAGE, - &tables, + &objects, concurrentCons, progname, echo, quiet); } @@ -368,6 +399,41 @@ main(int argc, char *argv[]) exit(0); } +/* + * Verify that the filters used at command line are compatible. + */ +void +check_objfilter(void) +{ + if ((objfilter & OBJFILTER_ALL_DBS) && + (objfilter & OBJFILTER_DATABASE)) + pg_fatal("cannot vacuum all databases and a specific one at the same time"); + + if ((objfilter & OBJFILTER_ALL_DBS) && + (objfilter & OBJFILTER_TABLE)) + pg_fatal("cannot vacuum specific table(s) in all databases"); + + if ((objfilter & OBJFILTER_ALL_DBS) && + (objfilter & OBJFILTER_SCHEMA)) + pg_fatal("cannot vacuum specific schema(s) in all databases"); + + if ((objfilter & OBJFILTER_ALL_DBS) && + (objfilter & OBJFILTER_SCHEMA_EXCLUDE)) + pg_fatal("cannot exclude specific schema(s) in all databases"); + + if ((objfilter & OBJFILTER_TABLE) && + (objfilter & OBJFILTER_SCHEMA)) + pg_fatal("cannot vacuum all tables in schema(s) and specific table(s) at the same time"); + + if ((objfilter & OBJFILTER_TABLE) && + (objfilter & OBJFILTER_SCHEMA_EXCLUDE)) + pg_fatal("cannot vacuum specific table(s) and exclude schema(s) at the same time"); + + if ((objfilter & OBJFILTER_SCHEMA) && + (objfilter & OBJFILTER_SCHEMA_EXCLUDE)) + pg_fatal("cannot vacuum all tables in schema(s) and exclude schema(s) at the same time"); +} + /* * vacuum_one_database * @@ -385,7 +451,7 @@ static void vacuum_one_database(ConnParams *cparams, vacuumingOptions *vacopts, int stage, - SimpleStringList *tables, + SimpleStringList *objects, int concurrentCons, const char *progname, bool echo, bool quiet) { @@ -400,7 +466,7 @@ vacuum_one_database(ConnParams *cparams, int i; int ntups; bool failed = false; - bool tables_listed = false; + bool objects_listed = false; bool has_where = false; const char *initcmd; const char *stage_commands[] = { @@ -499,31 +565,41 @@ vacuum_one_database(ConnParams *cparams, * catalog query will fail. */ initPQExpBuffer(&catalog_query); - for (cell = tables ? tables->head : NULL; cell; cell = cell->next) + for (cell = objects ? objects->head : NULL; cell; cell = cell->next) { - char *just_table; - const char *just_columns; + char *just_table = NULL; + const char *just_columns = NULL; - /* - * Split relation and column names given by the user, this is used to - * feed the CTE with values on which are performed pre-run validity - * checks as well. For now these happen only on the relation name. - */ - splitTableColumnsSpec(cell->val, PQclientEncoding(conn), - &just_table, &just_columns); - - if (!tables_listed) + if (!objects_listed) { appendPQExpBufferStr(&catalog_query, - "WITH listed_tables (table_oid, column_list) " + "WITH listed_objects (object_oid, column_list) " "AS (\n VALUES ("); - tables_listed = true; + objects_listed = true; } else appendPQExpBufferStr(&catalog_query, ",\n ("); - appendStringLiteralConn(&catalog_query, just_table, conn); - appendPQExpBufferStr(&catalog_query, "::pg_catalog.regclass, "); + if (objfilter & (OBJFILTER_SCHEMA | OBJFILTER_SCHEMA_EXCLUDE)) + { + appendStringLiteralConn(&catalog_query, cell->val, conn); + appendPQExpBufferStr(&catalog_query, "::pg_catalog.regnamespace, "); + } + + if (objfilter & OBJFILTER_TABLE) + { + /* + * Split relation and column names given by the user, this is used + * to feed the CTE with values on which are performed pre-run + * validity checks as well. For now these happen only on the + * relation name. + */ + splitTableColumnsSpec(cell->val, PQclientEncoding(conn), + &just_table, &just_columns); + + appendStringLiteralConn(&catalog_query, just_table, conn); + appendPQExpBufferStr(&catalog_query, "::pg_catalog.regclass, "); + } if (just_columns && just_columns[0] != '\0') appendStringLiteralConn(&catalog_query, just_columns, conn); @@ -536,13 +612,13 @@ vacuum_one_database(ConnParams *cparams, } /* Finish formatting the CTE */ - if (tables_listed) + if (objects_listed) appendPQExpBufferStr(&catalog_query, "\n)\n"); appendPQExpBufferStr(&catalog_query, "SELECT c.relname, ns.nspname"); - if (tables_listed) - appendPQExpBufferStr(&catalog_query, ", listed_tables.column_list"); + if (objects_listed) + appendPQExpBufferStr(&catalog_query, ", listed_objects.column_list"); appendPQExpBufferStr(&catalog_query, " FROM pg_catalog.pg_class c\n" @@ -551,10 +627,22 @@ vacuum_one_database(ConnParams *cparams, " LEFT JOIN pg_catalog.pg_class t" " ON c.reltoastrelid OPERATOR(pg_catalog.=) t.oid\n"); - /* Used to match the tables listed by the user */ - if (tables_listed) - appendPQExpBufferStr(&catalog_query, " JOIN listed_tables" - " ON listed_tables.table_oid OPERATOR(pg_catalog.=) c.oid\n"); + /* Used to match the tables or schemas listed by the user */ + if (objects_listed) + { + appendPQExpBufferStr(&catalog_query, " JOIN listed_objects" + " ON listed_objects.object_oid "); + + if (objfilter & OBJFILTER_SCHEMA_EXCLUDE) + appendPQExpBufferStr(&catalog_query, "OPERATOR(pg_catalog.!=) "); + else + appendPQExpBufferStr(&catalog_query, "OPERATOR(pg_catalog.=) "); + + if (objfilter & OBJFILTER_TABLE) + appendPQExpBufferStr(&catalog_query, "c.oid\n"); + else + appendPQExpBufferStr(&catalog_query, "ns.oid\n"); + } /* * If no tables were listed, filter for the relevant relation types. If @@ -562,7 +650,7 @@ vacuum_one_database(ConnParams *cparams, * Instead, let the server decide whether a given relation can be * processed in which case the user will know about it. */ - if (!tables_listed) + if ((objfilter & OBJFILTER_TABLE) == 0) { appendPQExpBufferStr(&catalog_query, " WHERE c.relkind OPERATOR(pg_catalog.=) ANY (array[" CppAsString2(RELKIND_RELATION) ", " @@ -633,7 +721,7 @@ vacuum_one_database(ConnParams *cparams, fmtQualifiedId(PQgetvalue(res, i, 1), PQgetvalue(res, i, 0))); - if (tables_listed && !PQgetisnull(res, i, 2)) + if (objects_listed && !PQgetisnull(res, i, 2)) appendPQExpBufferStr(&buf, PQgetvalue(res, i, 2)); simple_string_list_append(&dbtables, buf.data); @@ -977,6 +1065,8 @@ help(const char *progname) printf(_(" --no-index-cleanup don't remove index entries that point to dead tuples\n")); printf(_(" --no-process-toast skip the TOAST table associated with the table to vacuum\n")); printf(_(" --no-truncate don't truncate empty pages at the end of the table\n")); + printf(_(" -n, --schema=PATTERN vacuum tables in the specified schema(s) only\n")); + printf(_(" -N, --exclude-schema=PATTERN do not vacuum tables in the specified schema(s)\n")); printf(_(" -P, --parallel=PARALLEL_WORKERS use this many background workers for vacuum, if available\n")); printf(_(" -q, --quiet don't write any messages\n")); printf(_(" --skip-locked skip relations that cannot be immediately locked\n"));