diff options
author | Tom Lane | 2011-07-05 19:38:18 +0000 |
---|---|---|
committer | Tom Lane | 2011-07-05 19:38:29 +0000 |
commit | 8b6c89ad13921c7f24e205425f91f6ffda06235a (patch) | |
tree | d94bd27341b11cc0190c5fabdaeafd2c38fa2175 | |
parent | 2683a6340de9bda16b436b6d641ea63607ef1009 (diff) |
Improve documentation about foreign data wrapper validator functions.
Modified version of a patch by Shigeru Hanada.
-rw-r--r-- | doc/src/sgml/fdwhandler.sgml | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml index c8ae861852a..0637de7d1f6 100644 --- a/doc/src/sgml/fdwhandler.sgml +++ b/doc/src/sgml/fdwhandler.sgml @@ -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> |