CREATE SERVER

Description

CREATE SERVER defines a new foreign server.

Precautions

When multi-layer quotation marks are used for sensitive columns (such as password, secret_access_key) in OPTIONS, the semantics is different from that in the scenario where quotation marks are not used. Therefore, sensitive columns are not identified for anonymization.

Syntax

CREATE SERVER server_name
    FOREIGN DATA WRAPPER fdw_name
    OPTIONS ( { option_name ' value ' } [, ...] ) ;

Parameters

server_name

Specifies the server name.

Value range: a string containing no more than 63 characters
fdw_name

Specifies the name of the foreign data wrapper.

Value range: dist_fdw, log_fdw, and file_fdw. log_fdw and file_fdw are used only for syntax compatibility in centralized mode. They can be used to create foreign tables but are not actually used.
OPTIONS ( { option_name ' value ' } [, ...] )

Specifies options for the server. These options typically define the connection details of the server, but the actual names and values depend on the foreign data wrapper of the server.
- Specifies the parameters for the foreign server. The detailed parameter description is as follows:
  - encrypt
    Specifies whether data is encrypted. This parameter is available only when type is OBS. The default value is on.
    
    Value range:
    - on indicates that data is encrypted and HTTPS is used for communication.
    - off indicates that data is not encrypted and HTTP is used for communication.
  - access_key
    Specifies the access key (AK) (obtained by users from the OBS console) used for the OBS access protocol. This parameter is available only when type is set to OBS.
  - secret_access_key
    Specifies the secret key (SK) value (obtained by users from the OBS console) used for the OBS access protocol. This parameter is available only when type is set to OBS.

In addition to the connection parameters supported by libpq, the following parameters are provided:

fdw_startup_cost

Estimates the startup time required for a foreign table scan. This value usually contains the time taken to establish a connection, analyze the request at the remote end, and generate a plan. The default value is 100.
fdw_typle_cost

Specifies the additional consumption when each tuple is scanned on a remote server. The value specifies the extra consumption of data transmission between servers. The default value is 0.01.

Examples

-- Create a server.
gaussdb=# create server my_server foreign data wrapper log_fdw;
CREATE SERVER

-- Delete my_server.
gaussdb=# DROP SERVER my_server;
DROP SERVER