From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Tue, 5 Jul 2011 19:38:18 +0000 (-0400)
Subject: Improve documentation about foreign data wrapper validator functions.
X-Git-Tag: REL9_1_BETA3~16
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8b6c89ad13921c7f24e205425f91f6ffda06235a;p=postgresql

Improve documentation about foreign data wrapper validator functions.

Modified version of a patch by Shigeru Hanada.
---

diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml
index c8ae861852..0637de7d1f 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>