From 52a4255055f2f50c7f20917a47e2da04b8068fd6 Mon Sep 17 00:00:00 2001
From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Tue, 5 Jul 2011 15:38:18 -0400
Subject: [PATCH] Improve documentation about foreign data wrapper validator
functions.
Modified version of a patch by Shigeru Hanada.
---
doc/src/sgml/fdwhandler.sgml | 16 +++++++++++-----
1 file 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>
--
GitLab