table of contents
CREATE SERVER(7) | PostgreSQL 17.0 Documentation | CREATE SERVER(7) |
NAME¶
CREATE_SERVER - define a new foreign server
SYNOPSIS¶
CREATE SERVER [ IF NOT EXISTS ] 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¶
IF NOT EXISTS
server_name
server_type
server_version
fdw_name
OPTIONS ( option 'value' [, ... ] )
NOTES¶
When using the dblink module, a foreign server's name can be used as an argument of the dblink_connect(3) function to indicate the connection parameters. It is necessary to have the USAGE privilege on the foreign server to be able to use it in this way.
If the foreign server supports sort pushdown, it is necessary for it to have the same sort ordering as the local server.
EXAMPLES¶
Create a server myserver that uses the foreign-data wrapper postgres_fdw:
CREATE SERVER myserver FOREIGN DATA WRAPPER postgres_fdw OPTIONS (host 'foo', dbname 'foodb', port '5432');
See postgres_fdw for more details.
COMPATIBILITY¶
CREATE SERVER conforms to ISO/IEC 9075-9 (SQL/MED).
SEE ALSO¶
ALTER SERVER (ALTER_SERVER(7)), DROP SERVER (DROP_SERVER(7)), CREATE FOREIGN DATA WRAPPER (CREATE_FOREIGN_DATA_WRAPPER(7)), CREATE FOREIGN TABLE (CREATE_FOREIGN_TABLE(7)), CREATE USER MAPPING (CREATE_USER_MAPPING(7))
2024 | PostgreSQL 17.0 |