From 522ed12f7c600243870b13d9ff59f8fd5af10978 Mon Sep 17 00:00:00 2001 From: Dean Rasheed Date: Wed, 20 Mar 2024 08:05:44 +0000 Subject: [PATCH] Add "--exclude-extension" to pg_dump's options. This option (or equivalently specifying "exclude extension pattern" in a filter file) allows extensions matching the specified pattern to be excluded from the dump. Ayush Vatsa, reviewed by Junwang Zhao, Dean Rasheed, and Daniel Gustafsson. Discussion: https://postgr.es/m/CACX+KaP=VgVy9h-EUh598DTu+-fNr1jyEmpghC8rRp9s=w33Kg@mail.gmail.com --- doc/src/sgml/ref/pg_dump.sgml | 34 ++++++-- src/bin/pg_dump/pg_dump.c | 33 +++++++- src/test/modules/test_pg_dump/t/001_base.pl | 88 ++++++++++++++++++--- 3 files changed, 139 insertions(+), 16 deletions(-) diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 0caf56e0e0..8edf03a03d 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -256,6 +256,27 @@ PostgreSQL documentation + + + + + Do not dump any extensions matching pattern. The pattern is + interpreted according to the same rules as for . + can be given more than once to exclude extensions + matching any of several patterns. + + + + When both and are given, the behavior + is to dump just the extensions that match at least one + switch but no switches. If + appears without , then extensions matching are + excluded from what is otherwise a normal dump. + + + + @@ -848,10 +869,11 @@ PostgreSQL documentation or for tables, / for schemas, - for data on foreign servers and + for data on foreign servers, , - for table data, - / for extensions. + for table data, and + / or + for extensions. To read from STDIN, use - as the filename. The option can be specified in conjunction with the above listed options for including or excluding @@ -874,8 +896,7 @@ PostgreSQL documentation extension: extensions, works like the - option. This keyword can only be - used with the include keyword. + / option. @@ -1278,7 +1299,8 @@ PostgreSQL documentation This option has no effect - on /, + on , + /, /, or . An exclude pattern failing to match any objects is not considered an error. diff --git a/src/bin/pg_dump/pg_dump.c b/src/bin/pg_dump/pg_dump.c index a5149ca823..3ab7c6676a 100644 --- a/src/bin/pg_dump/pg_dump.c +++ b/src/bin/pg_dump/pg_dump.c @@ -136,6 +136,9 @@ static SimpleOidList foreign_servers_include_oids = {NULL, NULL}; static SimpleStringList extension_include_patterns = {NULL, NULL}; static SimpleOidList extension_include_oids = {NULL, NULL}; +static SimpleStringList extension_exclude_patterns = {NULL, NULL}; +static SimpleOidList extension_exclude_oids = {NULL, NULL}; + static const CatalogId nilCatalogId = {0, 0}; /* override for standard extra_float_digits setting */ @@ -437,6 +440,7 @@ main(int argc, char **argv) {"exclude-table-data-and-children", required_argument, NULL, 14}, {"sync-method", required_argument, NULL, 15}, {"filter", required_argument, NULL, 16}, + {"exclude-extension", required_argument, NULL, 17}, {NULL, 0, NULL, 0} }; @@ -672,6 +676,11 @@ main(int argc, char **argv) read_dump_filters(optarg, &dopt); break; + case 17: /* exclude extension(s) */ + simple_string_list_append(&extension_exclude_patterns, + optarg); + break; + default: /* getopt_long already emitted a complaint */ pg_log_error_hint("Try \"%s --help\" for more information.", progname); @@ -890,6 +899,10 @@ main(int argc, char **argv) if (extension_include_oids.head == NULL) pg_fatal("no matching extensions were found"); } + expand_extension_name_patterns(fout, &extension_exclude_patterns, + &extension_exclude_oids, + false); + /* non-matching exclusion patterns aren't an error */ /* * Dumping LOs is the default for dumps where an inclusion switch is not @@ -1095,6 +1108,7 @@ help(const char *progname) printf(_(" -c, --clean clean (drop) database objects before recreating\n")); printf(_(" -C, --create include commands to create database in dump\n")); printf(_(" -e, --extension=PATTERN dump the specified extension(s) only\n")); + printf(_(" --exclude-extension=PATTERN do NOT dump the specified extension(s)\n")); printf(_(" -E, --encoding=ENCODING dump the data in encoding ENCODING\n")); printf(_(" -n, --schema=PATTERN dump the specified schema(s) only\n")); printf(_(" -N, --exclude-schema=PATTERN do NOT dump the specified schema(s)\n")); @@ -2028,6 +2042,12 @@ selectDumpableExtension(ExtensionInfo *extinfo, DumpOptions *dopt) extinfo->dobj.dump = extinfo->dobj.dump_contains = dopt->include_everything ? DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE; + + /* check that the extension is not explicitly excluded */ + if (extinfo->dobj.dump && + simple_oid_list_member(&extension_exclude_oids, + extinfo->dobj.catId.oid)) + extinfo->dobj.dump = extinfo->dobj.dump_contains = DUMP_COMPONENT_NONE; } } @@ -18265,6 +18285,15 @@ processExtensionTables(Archive *fout, ExtensionInfo extinfo[], curext->dobj.catId.oid)) continue; + /* + * Check if this extension is listed as to exclude in the dump. If + * yes, any table data associated with it is discarded. + */ + if (extension_exclude_oids.head != NULL && + simple_oid_list_member(&extension_exclude_oids, + curext->dobj.catId.oid)) + continue; + if (strlen(extconfig) != 0 || strlen(extcondition) != 0) { int j; @@ -18965,7 +18994,6 @@ read_dump_filters(const char *filename, DumpOptions *dopt) case FILTER_OBJECT_TYPE_FUNCTION: case FILTER_OBJECT_TYPE_INDEX: case FILTER_OBJECT_TYPE_TRIGGER: - case FILTER_OBJECT_TYPE_EXTENSION: case FILTER_OBJECT_TYPE_FOREIGN_DATA: pg_log_filter_error(&fstate, _("%s filter for \"%s\" is not allowed"), "exclude", @@ -18973,6 +19001,9 @@ read_dump_filters(const char *filename, DumpOptions *dopt) exit_nicely(1); break; + case FILTER_OBJECT_TYPE_EXTENSION: + simple_string_list_append(&extension_exclude_patterns, objname); + break; case FILTER_OBJECT_TYPE_TABLE_DATA: simple_string_list_append(&tabledata_exclude_patterns, objname); diff --git a/src/test/modules/test_pg_dump/t/001_base.pl b/src/test/modules/test_pg_dump/t/001_base.pl index b8c30c2387..4266f26c65 100644 --- a/src/test/modules/test_pg_dump/t/001_base.pl +++ b/src/test/modules/test_pg_dump/t/001_base.pl @@ -220,6 +220,19 @@ my %pgdump_runs = ( '--extension=test_pg_dump', 'postgres', ], }, + exclude_extension => { + dump_cmd => [ + 'pg_dump', '--no-sync', "--file=$tempdir/exclude_extension.sql", + '--exclude-extension=test_pg_dump', 'postgres', + ], + }, + exclude_extension_filter => { + dump_cmd => [ + 'pg_dump', '--no-sync', + "--file=$tempdir/exclude_extension_filter.sql", + "--filter=$tempdir/exclude_extension_filter.txt", 'postgres', + ], + }, # plpgsql in the list blocks the dump of extension test_pg_dump without_extension => { @@ -299,6 +312,8 @@ my %full_runs = ( no_owner => 1, privileged_internals => 1, with_extension => 1, + exclude_extension => 1, + exclude_extension_filter => 1, without_extension => 1); my %tests = ( @@ -325,7 +340,12 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { binary_upgrade => 1, without_extension => 1 }, + unlike => { + binary_upgrade => 1, + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1 + }, }, 'CREATE ROLE regress_dump_test_role' => { @@ -434,7 +454,11 @@ my %tests = ( section_data => 1, extension_schema => 1, }, - unlike => { without_extension => 1, }, + unlike => { + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1, + }, }, 'CREATE TABLE regress_pg_dump_table' => { @@ -460,6 +484,8 @@ my %tests = ( unlike => { binary_upgrade => 1, exclude_table => 1, + exclude_extension => 1, + exclude_extension_filter => 1, without_extension => 1, }, }, @@ -483,7 +509,12 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { no_privs => 1, without_extension => 1, }, + unlike => { + no_privs => 1, + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1, + }, }, 'REVOKE GRANT OPTION FOR UPDATE ON SEQUENCE wgo_then_regular' => { @@ -500,7 +531,12 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { no_privs => 1, without_extension => 1, }, + unlike => { + no_privs => 1, + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1, + }, }, 'CREATE ACCESS METHOD regress_test_am' => { @@ -520,7 +556,11 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { without_extension => 1, }, + unlike => { + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1, + }, }, 'GRANT SELECT regress_pg_dump_table_added pre-ALTER EXTENSION' => { @@ -545,7 +585,12 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { no_privs => 1, without_extension => 1, }, + unlike => { + no_privs => 1, + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1, + }, }, 'GRANT SELECT ON TABLE regress_pg_dump_table' => { @@ -579,7 +624,12 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { no_privs => 1, without_extension => 1 }, + unlike => { + no_privs => 1, + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1 + }, }, 'GRANT USAGE ON regress_pg_dump_table_col1_seq TO regress_dump_test_role' @@ -595,7 +645,12 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { no_privs => 1, without_extension => 1, }, + unlike => { + no_privs => 1, + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1, + }, }, 'GRANT USAGE ON regress_pg_dump_seq TO regress_dump_test_role' => { @@ -617,7 +672,12 @@ my %tests = ( schema_only => 1, section_pre_data => 1, }, - unlike => { no_privs => 1, without_extension => 1, }, + unlike => { + no_privs => 1, + exclude_extension => 1, + exclude_extension_filter => 1, + without_extension => 1, + }, }, # Objects included in extension part of a schema created by this extension */ @@ -818,6 +878,16 @@ foreach my $test ( # Send the combined set of commands to psql $node->safe_psql('postgres', $create_sql); +######################################### +# Create filter file for exclude_extension_filter test + +my $filterfile; + +open $filterfile, '>', "$tempdir/exclude_extension_filter.txt" + or die "unable to open filter file for writing"; +print $filterfile "exclude extension test_pg_dump\n"; +close $filterfile; + ######################################### # Run all runs