CREATE SERVER

CREATE SERVER — define a new foreign server

Synopsis

  1. CREATE SERVER [IF NOT EXISTS] 
  2. server_name
  3.  [ TYPE '
  4. server_type
  5. ' ] [ VERSION '
  6. server_version
  7. ' ]
  8.     FOREIGN DATA WRAPPER 
  9. fdw_name
  11.     [ OPTIONS ( 
  12. option
  13.  '
  14. value
  15. ' [, ... ] ) ]

Description

CREATE SERVERdefines 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 requiresUSAGEprivilege on the foreign-data wrapper being used.

Parameters

IF NOT EXISTS

Do not throw an error if a server with the same name already exists. A notice is issued in this case. Note that there is no guarantee that the existing server is anything like the one that would have been created.

server_name

The name of the foreign server to be created.

server_type

Optional server type, potentially useful to foreign-data wrappers.

server_version

Optional server version, potentially useful to foreign-data wrappers.

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 thedblinkmodule, a foreign server’s name can be used as an argument of thedblink_connectfunction to indicate the connection parameters. It is necessary to have theUSAGEprivilege on the foreign server to be able to use it in this way.

Examples

Create a servermyserverthat uses the foreign-data wrapperpostgres_fdw:

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

Seepostgres_fdwfor more details.

Compatibility

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

See Also

ALTER SERVER

,

DROP SERVER

,

CREATE FOREIGN DATA WRAPPER

,

CREATE FOREIGN TABLE

,

CREATE USER MAPPING