po 13. 7. 2020 v 20:00 odesÃlatel Justin Pryzby <pry...@telsasoft.com> napsal:
> On Mon, Jul 13, 2020 at 08:15:42AM +0200, Pavel Stehule wrote: > > > Do you want to add any more documentation ? > > > > > > > done > > Thanks - I think the documentation was maybe excessive. See attached. > I merged your patch - thank you new patch with doc changes and text of help change requested by Vignesh attached Regards Pavel > -- > Justin >
diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 7a37fd8045..c9502dca13 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -755,6 +755,50 @@ PostgreSQL documentation </listitem> </varlistentry> + <varlistentry> + <term><option>--filter=<replaceable class="parameter">filename</replaceable></option></term> + <listitem> + <para> + Read objects filters from the specified file. + If you use "-" as a filename, the filters are read from stdin. + The lines of this file must have the following format: +<synopsis> +(+|-)[tnfd] <replaceable class="parameter">objectname</replaceable> +</synopsis> + </para> + + <para> + The first character specifies whether the object is to be included + (<literal>+</literal>) or excluded (<literal>-</literal>), and the + second character specifies the type of object to be filtered: + <literal>t</literal> (table), + <literal>n</literal> (schema), + <literal>f</literal> (foreign table), + <literal>d</literal> (table data). + </para> + + <para> + With the following filter file, the dump would include table + <literal>mytable1</literal> and data from foreign table + <literal>some_foreign_table</literal>, but exclude data + from table <literal>mytable2</literal>. +<programlisting> ++t mytable1 ++f some_foreign_table +-d mytable2 +</programlisting> + </para> + + <para> + The <option>--filter</option> option works just like the other + options to include or exclude tables, schemas, table data, or foreign + tables, and both forms may be combined. Note that there are no options + to exclude a specific foreign table or to include a specific table's + data. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><option>--if-exists</option></term> <listitem> diff --git a/src/bin/pg_dump/pg_dump.c b/src/bin/pg_dump/pg_dump.c index e758b5c50a..778ae2d0fc 100644 --- a/src/bin/pg_dump/pg_dump.c +++ b/src/bin/pg_dump/pg_dump.c @@ -290,6 +290,7 @@ static void appendReloptionsArrayAH(PQExpBuffer buffer, const char *reloptions, static char *get_synchronized_snapshot(Archive *fout); static void setupDumpWorker(Archive *AHX); static TableInfo *getRootTableInfo(TableInfo *tbinfo); +static void read_patterns_from_file(char *filename, DumpOptions *dopt); int @@ -364,6 +365,7 @@ main(int argc, char **argv) {"enable-row-security", no_argument, &dopt.enable_row_security, 1}, {"exclude-table-data", required_argument, NULL, 4}, {"extra-float-digits", required_argument, NULL, 8}, + {"filter", required_argument, NULL, 12}, {"if-exists", no_argument, &dopt.if_exists, 1}, {"inserts", no_argument, NULL, 9}, {"lock-wait-timeout", required_argument, NULL, 2}, @@ -603,6 +605,10 @@ main(int argc, char **argv) optarg); break; + case 12: /* filter implementation */ + read_patterns_from_file(optarg, &dopt); + break; + default: fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname); exit_nicely(1); @@ -1022,6 +1028,8 @@ help(const char *progname) " access to)\n")); printf(_(" --exclude-table-data=PATTERN do NOT dump data for the specified table(s)\n")); printf(_(" --extra-float-digits=NUM override default setting for extra_float_digits\n")); + printf(_(" --filter=FILENAME dump objects and data based on the filter expressions\n" + " from the filter file\n")); printf(_(" --if-exists use IF EXISTS when dropping objects\n")); printf(_(" --include-foreign-data=PATTERN\n" " include data of foreign tables on foreign\n" @@ -18597,3 +18605,211 @@ appendReloptionsArrayAH(PQExpBuffer buffer, const char *reloptions, if (!res) pg_log_warning("could not parse reloptions array"); } + +#define FILTER_INITIAL_LINE_SIZE 1024 +#define PG_GETLINE_EXTEND_LINE_SIZE 1024 + +/* + * getline is originally GNU function, and should not be everywhere still. + * Use own reduced implementation. + */ +static size_t +pg_getline(char **lineptr, size_t *n, FILE *fp) +{ + size_t total_chars = 0; + + while (!feof(fp) && !ferror(fp)) + { + char *str; + size_t chars; + + str = fgets(*lineptr + total_chars, + *n - total_chars, + fp); + + if (ferror(fp)) + return -1; + + if (str) + { + chars = strlen(str); + total_chars += chars; + + if (chars > 0 && str[chars - 1] == '\n') + return total_chars; + + /* check, if there is good enough space for next content */ + if (*n - total_chars < 2) + { + *n += PG_GETLINE_EXTEND_LINE_SIZE; + *lineptr = pg_realloc(*lineptr, *n); + } + } + else + break; + } + + if (ferror(fp)) + return -1; + + return total_chars > 0 ? total_chars : -1; +} + +/* + * Print error message and exit. + */ +static void +exit_invalid_filter_format(FILE *fp, char *filename, char *message, char *line, int lineno) +{ + pg_log_error("invalid format of filter file \"%s\": %s", + filename, + message); + + fprintf(stderr, "%d: %s\n", lineno, line); + + if (fp != stdin) + fclose(fp); + + exit_nicely(-1); +} + +/* + * Read dumped object specification from file + */ +static void +read_patterns_from_file(char *filename, DumpOptions *dopt) +{ + FILE *fp; + char *line; + ssize_t chars; + size_t line_size = FILTER_INITIAL_LINE_SIZE; + int lineno = 0; + + /* use "-" as symbol for stdin */ + if (strcmp(filename, "-") != 0) + { + fp = fopen(filename, "r"); + if (!fp) + fatal("could not open the input file \"%s\": %m", + filename); + } + else + fp = stdin; + + line = pg_malloc(line_size); + + while ((chars = pg_getline(&line, &line_size, fp)) != -1) + { + bool is_include; + char objecttype; + char *objectname; + + lineno += 1; + + if (line[chars - 1] == '\n') + line[chars - 1] = '\0'; + + /* ignore empty rows */ + if (*line == '\0') + continue; + + /* when first char is hash, ignore whole line */ + if (*line == '#') + continue; + + if (chars < 2) + exit_invalid_filter_format(fp, + filename, + "line too short", + line, + lineno); + + if (line[0] == '+') + is_include = true; + else if (line[0] == '-') + is_include = false; + else + exit_invalid_filter_format(fp, + filename, + "invalid option type (use [+-]", + line, + lineno); + + objecttype = line[1]; + objectname = &line[2]; + + /* skip initial spaces */ + while (isspace(*objectname)) + objectname++; + + if (*objectname == '\0') + exit_invalid_filter_format(fp, + filename, + "missing object name", + line, + lineno); + + if (objecttype == 't') + { + if (is_include) + { + simple_string_list_append(&table_include_patterns, + objectname); + dopt->include_everything = false; + } + else + simple_string_list_append(&table_exclude_patterns, + objectname); + } + else if (objecttype == 'n') + { + if (is_include) + { + simple_string_list_append(&schema_include_patterns, + objectname); + dopt->include_everything = false; + } + else + simple_string_list_append(&schema_exclude_patterns, + objectname); + } + else if (objecttype == 'd') + { + if (is_include) + exit_invalid_filter_format(fp, + filename, + "include filter is not supported for this type of object", + line, + lineno); + else + simple_string_list_append(&tabledata_exclude_patterns, + objectname); + } + else if (objecttype == 'f') + { + if (is_include) + simple_string_list_append(&foreign_servers_include_patterns, + objectname); + else + exit_invalid_filter_format(fp, + filename, + "exclude filter is not supported for this type of object", + line, + lineno); + } + else + exit_invalid_filter_format(fp, + filename, + "invalid object type (use [tndf])", + line, + lineno); + } + + if (ferror(fp)) + fatal("could not read from file \"%s\": %m", filename); + + if (fp != stdin) + fclose(fp); + + pg_free(line); +}