Foreign Data Wrapper

Foreign Data Wrappers provide a standardized way of handling access to remote data stores.

Properties

Property	Type	Required	Description
name	string	—	The name of the foreign data wrapper to be created.
owner	string	—	The role name of the superuser who owns the Foreign Data Wrapper.
comment	string	—	An optional comment about the Foreign Data Wrapper.
handler	string	—	The name of a previously registered function that will be called to retrieve the execution functions for foreign tables. The handler function must take no arguments, and its return type must be fdw_handler. It is possible to create a foreign-data wrapper with no handler function, but foreign tables using such a wrapper can only be declared, not accessed.
validator	string	—	The name of a previously registered function that will be called to check the generic options given to the foreign-data wrapper, as well as options for foreign servers, user mappings and foreign tables using the foreign-data wrapper. If no validator function or NO VALIDATOR is specified, then options will not be checked at creation time. (Foreign-data wrappers will possibly ignore or reject invalid option specifications at run time, depending on the implementation.) The validator function must take two arguments: one of type text[], which will contain the array of options as stored in the system catalogs, and one of type oid, which will be the OID of the system catalog containing the options. The return type is ignored; the function should report invalid options using the ereport(ERROR) function.
options	object	—	This clause specifies options for the new foreign-data wrapper. The allowed option names and values are specific to each foreign data wrapper and are validated using the foreign-data wrapper's validator function. Option names must be unique.

No other properties are accepted.

---

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