Supported Versions: Current (16) / 15 / 14 / 13 / 12
Development Versions: devel
Unsupported versions: 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4
This documentation is for an unsupported version of PostgreSQL.
You may want to view the same page for the current version, or one of the other supported versions listed above instead.

CREATE SERVER

Name

CREATE SERVER -- define a new foreign server

Synopsis

CREATE SERVER servername [ TYPE 'servertype' ] [ VERSION 'serverversion' ]
    FOREIGN DATA WRAPPER fdwname
    [ 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

servername

The name of the foreign server to be created.

servertype

Optional server type.

serverversion

Optional server version.

fdwname

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 Section F.8), the foreign server name can be used as an argument of the dblink_connect 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).