From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Tue, 12 Mar 2013 23:06:43 +0000 (-0400)
Subject: Fix documentation oversight.
X-Git-Tag: REL9_3_BETA1~238
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=209f675f0f9094015414eee39c435ed3bf65d82a;p=postgresql

Fix documentation oversight.

Mention that PlanForeignModify's result must be copiable by copyObject.
---

diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml
index e6bce195e6..d11e3de895 100644
--- a/doc/src/sgml/fdwhandler.sgml
+++ b/doc/src/sgml/fdwhandler.sgml
@@ -899,6 +899,10 @@ GetForeignServerByName(const char *name, bool missing_ok);
      <literal>baserel-&gt;fdw_private</> data previously created by the
      scan-planning functions.  However, in <command>INSERT</> the target
      table is not scanned so there is no <structname>RelOptInfo</> for it.
+     The <structname>List</> returned by <function>PlanForeignModify</> has
+     the same restrictions as the <structfield>fdw_private</> list of a
+     <structname>ForeignScan</> plan node, that is it must contain only
+     structures that <function>copyObject</> knows how to copy.
     </para>
 
     <para>