Skip to content

Commit f246c48

Browse files
committed
doc: Mention AttributeRelationId in FDW validator function description
The documentation has been missing one value in the list of catalog OIDs that can be given to the validator function of a FDW, as of AttributeRelationId, when changing the attribute options of a foreign table. Author: Ian Lawrence Barwick Discussion: https://postgr.es/m/CAB8KJ=i16t2yJU_Pq2Z+hnNGWFhagp_bJmzxHZu3ZkOjZm-+rQ@mail.gmail.com Backpatch-through: 12
1 parent 58054de commit f246c48

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

doc/src/sgml/fdwhandler.sgml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,16 @@
6767
foreign tables using the wrapper.
6868
The validator function must be registered as taking two arguments, a
6969
text array containing the options to be validated, and an OID
70-
representing the type of object the options are associated with (in
71-
the form of the OID of the system catalog the object would be stored
72-
in, either
73-
<literal>ForeignDataWrapperRelationId</literal>,
74-
<literal>ForeignServerRelationId</literal>,
75-
<literal>UserMappingRelationId</literal>,
76-
or <literal>ForeignTableRelationId</literal>).
70+
representing the type of object the options are associated with. The
71+
latter corresponds to the OID of the system catalog the object
72+
would be stored in, one of:
73+
<itemizedlist spacing="compact">
74+
<listitem><para><literal>AttributeRelationId</literal></para></listitem>
75+
<listitem><para><literal>ForeignDataWrapperRelationId</literal></para></listitem>
76+
<listitem><para><literal>ForeignServerRelationId</literal></para></listitem>
77+
<listitem><para><literal>ForeignTableRelationId</literal></para></listitem>
78+
<listitem><para><literal>UserMappingRelationId</literal></para></listitem>
79+
</itemizedlist>
7780
If no validator function is supplied, options are not checked at object
7881
creation time or object alteration time.
7982
</para>

0 commit comments

Comments
 (0)