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
This commit is contained in:
Michael Paquier 2023-12-28 20:09:32 +09:00
parent b1010030e6
commit d2580bc312
1 changed files with 10 additions and 7 deletions

View File

@ -67,13 +67,16 @@
foreign tables using the wrapper. foreign tables using the wrapper.
The validator function must be registered as taking two arguments, a The validator function must be registered as taking two arguments, a
text array containing the options to be validated, and an OID text array containing the options to be validated, and an OID
representing the type of object the options are associated with (in representing the type of object the options are associated with. The
the form of the OID of the system catalog the object would be stored latter corresponds to the OID of the system catalog the object
in, either would be stored in, one of:
<literal>ForeignDataWrapperRelationId</literal>, <itemizedlist spacing="compact">
<literal>ForeignServerRelationId</literal>, <listitem><para><literal>AttributeRelationId</literal></para></listitem>
<literal>UserMappingRelationId</literal>, <listitem><para><literal>ForeignDataWrapperRelationId</literal></para></listitem>
or <literal>ForeignTableRelationId</literal>). <listitem><para><literal>ForeignServerRelationId</literal></para></listitem>
<listitem><para><literal>ForeignTableRelationId</literal></para></listitem>
<listitem><para><literal>UserMappingRelationId</literal></para></listitem>
</itemizedlist>
If no validator function is supplied, options are not checked at object If no validator function is supplied, options are not checked at object
creation time or object alteration time. creation time or object alteration time.
</para> </para>