aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorMichael Paquier <michael@paquier.xyz>2023-12-28 20:09:12 +0900
committerMichael Paquier <michael@paquier.xyz>2023-12-28 20:09:12 +0900
commitf246c48ac4ac323152d3569bed1ccd571a5cc3d8 (patch)
tree5298218a31b6a0c7fcc111dbdb6d8a7fc7343c0d /doc/src
parent58054de2d0847c09ef091956f72ae5e9fb9a176e (diff)
downloadpostgresql-f246c48ac4ac323152d3569bed1ccd571a5cc3d8.tar.gz
postgresql-f246c48ac4ac323152d3569bed1ccd571a5cc3d8.zip
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
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/fdwhandler.sgml17
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml
index 25832d227fb..b80320504d6 100644
--- a/doc/src/sgml/fdwhandler.sgml
+++ b/doc/src/sgml/fdwhandler.sgml
@@ -67,13 +67,16 @@
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, either
- <literal>ForeignDataWrapperRelationId</literal>,
- <literal>ForeignServerRelationId</literal>,
- <literal>UserMappingRelationId</literal>,
- or <literal>ForeignTableRelationId</literal>).
+ representing the type of object the options are associated with. The
+ latter corresponds to the OID of the system catalog the object
+ would be stored in, one of:
+ <itemizedlist spacing="compact">
+ <listitem><para><literal>AttributeRelationId</literal></para></listitem>
+ <listitem><para><literal>ForeignDataWrapperRelationId</literal></para></listitem>
+ <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
creation time or object alteration time.
</para>