Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 52a4255

Browse files
committed
Improve documentation about foreign data wrapper validator functions.
Modified version of a patch by Shigeru Hanada.
1 parent cab19af commit 52a4255

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

doc/src/sgml/fdwhandler.sgml

+11-5
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,20 @@
3838
</para>
3939

4040
<para>
41-
The validator function is responsible for validating options given in the
42-
<command>CREATE FOREIGN DATA WRAPPER</command>, <command>CREATE
43-
SERVER</command> and <command>CREATE FOREIGN TABLE</command> commands.
41+
The validator function is responsible for validating options given in
42+
<command>CREATE</command> and <command>ALTER</command> commands for its
43+
foreign data wrapper, as well as foreign servers, user mappings, and
44+
foreign tables using the wrapper.
4445
The validator function must be registered as taking two arguments, a text
4546
array containing the options to be validated, and an OID representing the
4647
type of object the options are associated with (in the form of the OID
47-
of the system catalog the object would be stored in). If no validator
48-
function is supplied, the options are not checked at object creation time.
48+
of the system catalog the object would be stored in, either
49+
<literal>ForeignDataWrapperRelationId</>,
50+
<literal>ForeignServerRelationId</>,
51+
<literal>UserMappingRelationId</>,
52+
or <literal>ForeignTableRelationId</>).
53+
If no validator function is supplied, options are not checked at object
54+
creation time or object alteration time.
4955
</para>
5056

5157
<para>

0 commit comments

Comments
 (0)