import_foreign_schema(7)

NAME#

IMPORT_FOREIGN_SCHEMA - import table definitions from a foreign server

SYNOPSIS#

IMPORT FOREIGN SCHEMA \nremote_schema\n
\n
    [ { LIMIT TO | EXCEPT } ( \ntable_name\n [, ...] ) ]
\n
    FROM SERVER \nserver_name\n
\n
    INTO \nlocal_schema\n
\n
    [ OPTIONS ( \noption\n '\nvalue\n' [, ... ] ) ]

DESCRIPTION#

IMPORT FOREIGN SCHEMA creates foreign tables that represent tables existing on a foreign server. The new foreign tables will be owned by the user issuing the command and are created with the correct column definitions and options to match the remote tables.

By default, all tables and views existing in a particular schema on the foreign server are imported. Optionally, the list of tables can be limited to a specified subset, or specific tables can be excluded. The new foreign tables are all created in the target schema, which must already exist.

To use IMPORT FOREIGN SCHEMA, the user must have USAGE privilege on the foreign server, as well as CREATE privilege on the target schema.

PARAMETERS#

remote_schema

LIMIT TO ( table_name [, ...] )

EXCEPT ( table_name [, ...] )

server_name

local_schema

OPTIONS ( option 'value' [, ...] )

EXAMPLES#

Import table definitions from a remote schema foreign_films on server film_server, creating the foreign tables in local schema films:

IMPORT FOREIGN SCHEMA foreign_films
\n
    FROM SERVER film_server INTO films;

As above, but import only the two tables actors and directors (if they exist):

IMPORT FOREIGN SCHEMA foreign_films LIMIT TO (actors, directors)
\n
    FROM SERVER film_server INTO films;

COMPATIBILITY#

The IMPORT FOREIGN SCHEMA command conforms to the SQL standard, except that the OPTIONS clause is a PostgreSQL extension.

SEE ALSO#

CREATE FOREIGN TABLE (CREATE_FOREIGN_TABLE(7)), CREATE SERVER (CREATE_SERVER(7))