mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation about foreign data wrapper validator functions.

Browse Source 
Modified version of a patch by Shigeru Hanada.
This commit is contained in:
Tom Lane 2011-07-05 15:38:18 -04:00
parent cab19af9fb
commit 52a4255055
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/src/sgml/fdwhandler.sgml
View File

@ -38,14 +38,20 @@
</para>
<para>
The validator function is responsible for validating options given in the
<command>CREATE FOREIGN DATA WRAPPER</command>, <command>CREATE
SERVER</command> and <command>CREATE FOREIGN TABLE</command> commands.
The validator function is responsible for validating options given in
<command>CREATE</command> and <command>ALTER</command> commands for its
foreign data wrapper, as well as foreign servers, user mappings, and
foreign tables using the wrapper.
The validator function must be registered as taking two arguments, a text
array containing the options to be validated, and an OID representing the
type of object the options are associated with (in the form of the OID
of the system catalog the object would be stored in). If no validator
function is supplied, the options are not checked at object creation time.
of the system catalog the object would be stored in, either
<literal>ForeignDataWrapperRelationId</>,
<literal>ForeignServerRelationId</>,
<literal>UserMappingRelationId</>,
or <literal>ForeignTableRelationId</>).
If no validator function is supplied, options are not checked at object
creation time or object alteration time.
</para>
<para>