From 8b6c89ad13921c7f24e205425f91f6ffda06235a Mon Sep 17 00:00:00 2001 From: Tom Lane 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 c8ae861852..0637de7d1f 100644 --- a/doc/src/sgml/fdwhandler.sgml +++ b/doc/src/sgml/fdwhandler.sgml @@ -38,14 +38,20 @@ - The validator function is responsible for validating options given in the - CREATE FOREIGN DATA WRAPPER, CREATE - SERVER and CREATE FOREIGN TABLE commands. + The validator function is responsible for validating options given in + CREATE and ALTER 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 + ForeignDataWrapperRelationId, + ForeignServerRelationId, + UserMappingRelationId, + or ForeignTableRelationId). + If no validator function is supplied, options are not checked at object + creation time or object alteration time. -- 2.40.0