CREATE_SERVER (7) - Linux Manuals

CREATE_SERVER: define a new foreign server

NAME

CREATE_SERVER - define a new foreign server

SYNOPSIS

CREATE SERVER server_name [ TYPE 'server_type' ] [ VERSION 'server_version' ]
    FOREIGN DATA WRAPPER fdw_name
    [ OPTIONS ( option 'value' [, ... ] ) ]

DESCRIPTION

CREATE SERVER defines a new foreign server. The user who defines the server becomes its owner.

A foreign server typically encapsulates connection information that a foreign-data wrapper uses to access an external data resource. Additional user-specific connection information may be specified by means of user mappings.

The server name must be unique within the database.

Creating a server requires USAGE privilege on the foreign-data wrapper being used.

PARAMETERS

server_name

The name of the foreign server to be created.

server_type

Optional server type.

server_version

Optional server version.

fdw_name

The name of the foreign-data wrapper that manages the server.

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

This clause specifies the options for the server. The options typically define the connection details of the server, but the actual names and values are dependent on the server's foreign-data wrapper.

NOTES

When using the dblink module (see dblink), the foreign server name can be used as an argument of the dblink_connect(3) function to indicate the connection parameters. See also there for more examples. It is necessary to have the USAGE privilege on the foreign server to be able to use it in this way.

EXAMPLES

Create a server foo that uses the built-in foreign-data wrapper default:

CREATE SERVER foo FOREIGN DATA WRAPPER "default";

Create a server myserver that uses the foreign-data wrapper pgsql:

CREATE SERVER myserver FOREIGN DATA WRAPPER pgsql OPTIONS (host 'foo', dbname 'foodb', port '5432');

COMPATIBILITY

CREATE SERVER conforms to ISO/IEC 9075-9 (SQL/MED).