<varlistentry>

<term><option>--include-foreign-data=<replaceable class="parameter">foreignserver</replaceable></option></term>

<listitem>

<para>

Dump the data for any foreign table with a foreign server

matching <replaceable class="parameter">foreignserver</replaceable>

pattern. Multiple foreign servers can be selected by writing multiple

<option>--include-foreign-data</option> switches.

Also, the <replaceable class="parameter">foreignserver</replaceable> parameter is

interpreted as a pattern according to the same rules used by

<application>psql</application>'s <literal>\d</literal> commands (see <xref

linkend="app-psql-patterns" endterm="app-psql-patterns-title"/>),

so multiple foreign servers can also be selected by writing wildcard characters

in the pattern. When using wildcards, be careful to quote the pattern

if needed to prevent the shell from expanding the wildcards; see

<xref linkend="pg-dump-examples" endterm="pg-dump-examples-title"/>.

The only exception is that an empty pattern is disallowed.

</para>

<note>

<para>

When <option>--include-foreign-data</option> is specified,

<application>pg_dump</application> does not check that the foreign

table is writeable. Therefore, there is no guarantee that the

results of a foreign table dump can be successfully restored.

</para>

</note>

</listitem>

</varlistentry>

static SimpleStringList foreign_servers_include_patterns = {NULL, NULL};

static SimpleOidList foreign_servers_include_oids = {NULL, NULL};

static void expand_foreign_server_name_patterns(Archive *fout,

SimpleStringList *patterns,

SimpleOidList *oids);

{"include-foreign-data", required_argument, NULL, 11},

case 11: /* include foreign data */

simple_string_list_append(&foreign_servers_include_patterns,

optarg);

break;

if (dopt.schemaOnly && foreign_servers_include_patterns.head != NULL)

fatal("options -s/--schema-only and --include-foreign-data cannot be used together");

if (numWorkers > 1 && foreign_servers_include_patterns.head != NULL)

fatal("option --include-foreign-data is not supported with parallel backup");

expand_foreign_server_name_patterns(fout, &foreign_servers_include_patterns,

&foreign_servers_include_oids);

printf(_(" --include-foreign-data=PATTERN\n"

" include data of foreign tables in\n"

" foreign servers matching PATTERN\n"));

/*

* Find the OIDs of all foreign servers matching the given list of patterns,

* and append them to the given OID list.

*/

static void

expand_foreign_server_name_patterns(Archive *fout,

SimpleStringList *patterns,

SimpleOidList *oids)

{

PQExpBuffer query;

PGresult *res;

SimpleStringListCell *cell;

int i;

if (patterns->head == NULL)

return; /* nothing to do */

query = createPQExpBuffer();

/*

* The loop below runs multiple SELECTs might sometimes result in

* duplicate entries in the OID list, but we don't care.

*/

for (cell = patterns->head; cell; cell = cell->next)

{

appendPQExpBuffer(query,

"SELECT oid FROM pg_catalog.pg_foreign_server s\n");

processSQLNamePattern(GetConnection(fout), query, cell->val, false,

false, NULL, "s.srvname", NULL, NULL);

res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);

if (PQntuples(res) == 0)

fatal("no matching foreign servers were found for pattern \"%s\"", cell->val);

for (i = 0; i < PQntuples(res); i++)

simple_oid_list_append(oids, atooid(PQgetvalue(res, i, 0)));

PQclear(res);

resetPQExpBuffer(query);

}

destroyPQExpBuffer(query);

}

/*

* Use COPY (SELECT ...) TO when dumping a foreign table's data, and when

* a filter condition was specified. For other cases a simple COPY

* suffices.

*/

if (tdinfo->filtercond || tbinfo->relkind == RELKIND_FOREIGN_TABLE)

tdinfo->filtercond ? tdinfo->filtercond : "");

/* Skip FOREIGN TABLEs (no data to dump) unless requested explicitly */

if (tbinfo->relkind == RELKIND_FOREIGN_TABLE &&

(foreign_servers_include_oids.head == NULL ||

!simple_oid_list_member(&foreign_servers_include_oids,

tbinfo->foreign_server)))

int i_foreignserver;

"CASE WHEN c.relkind = 'f' THEN "

"(SELECT ftserver FROM pg_catalog.pg_foreign_table WHERE ftrelid = c.oid) "

"ELSE 0 END AS foreignserver, "

"CASE WHEN c.relkind = 'f' THEN "

"(SELECT ftserver FROM pg_catalog.pg_foreign_table WHERE ftrelid = c.oid) "

"ELSE 0 END AS foreignserver, "

"CASE WHEN c.relkind = 'f' THEN "

"(SELECT ftserver FROM pg_catalog.pg_foreign_table WHERE ftrelid = c.oid) "

"ELSE 0 END AS foreignserver, "

"CASE WHEN c.relkind = 'f' THEN "

"(SELECT ftserver FROM pg_catalog.pg_foreign_table WHERE ftrelid = c.oid) "

"ELSE 0 END AS foreignserver, "

"CASE WHEN c.relkind = 'f' THEN "

"(SELECT ftserver FROM pg_catalog.pg_foreign_table WHERE ftrelid = c.oid) "

"ELSE 0 END AS foreignserver, "

"NULL AS foreignserver, "

"NULL AS foreignserver, "

"NULL AS foreignserver, "

"NULL AS foreignserver, "

i_foreignserver = PQfnumber(res, "foreignserver");

/* foreign server */

tblinfo[i].foreign_server = atooid(PQgetvalue(res, i, i_foreignserver));

Oid foreign_server; /* foreign server oid, if applicable */

use Test::More tests => 78;

command_fails_like(

[ 'pg_dump', '-s', '--include-foreign-data=xxx' ],

qr/\Qpg_dump: error: options -s\/--schema-only and --include-foreign-data cannot be used together\E/,

'pg_dump: options -s/--schema-only and --include-foreign-data cannot be used together'

);

command_fails_like(

[ 'pg_dump', '-j2', '--include-foreign-data=xxx' ],

qr/\Qpg_dump: error: option --include-foreign-data is not supported with parallel backup\E/,

'pg_dump: option --include-foreign-data is not supported with parallel backup'

);

use strict;

use warnings;

use PostgresNode;

use TestLib;

use Test::More tests => 3;

my $tempdir = TestLib::tempdir;

my $tempdir_short = TestLib::tempdir_short;

my $node = get_new_node('main');

my $port = $node->port;

$node->init;

$node->start;

$node->safe_psql( 'postgres', "CREATE FOREIGN DATA WRAPPER dummy");

$node->safe_psql( 'postgres', "CREATE SERVER s0 FOREIGN DATA WRAPPER dummy");

$node->safe_psql( 'postgres', "CREATE SERVER s1 FOREIGN DATA WRAPPER dummy");

$node->safe_psql( 'postgres', "CREATE SERVER s2 FOREIGN DATA WRAPPER dummy");

$node->safe_psql( 'postgres', "CREATE FOREIGN TABLE t0 (a int) SERVER s0");

$node->safe_psql( 'postgres', "CREATE FOREIGN TABLE t1 (a int) SERVER s1");

my ($cmd, $stdout, $stderr, $result);

command_fails_like(

[ "pg_dump", '-p', $port, 'postgres', '--include-foreign-data=s0' ],

qr/foreign-data wrapper \"dummy\" has no handler\r?\npg_dump: error: query was:.*t0/,

"correctly fails to dump a foreign table from a dummy FDW");

command_ok(

[ "pg_dump", '-p', $port, 'postgres', '-a', '--include-foreign-data=s2' ] ,

"dump foreign server with no tables");