Skip to content

Server

A foreign server typically encapsulates connection information that a foreign-data wrapper uses to access an external data resource.

Properties

Property Type Required Description
name string yes The name of the server to be created.
foreign_data_wrapper string yes The name of the foreign-data wrapper that manages the server.
type string Optional server type, potentially useful to foreign-data wrappers.
version string Optional server version, potentially useful to foreign-data wrappers.
comment string An optional comment about the server.
options object 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.
dependencies dependencies Database objects this object is dependent upon.

No other properties are accepted.


Source: schemata/server.yml · Resolved JSON Schema: server.json