diff options
| author | Robert Haas <rhaas@postgresql.org> | 2016-03-04 11:41:23 -0500 |
|---|---|---|
| committer | Robert Haas <rhaas@postgresql.org> | 2016-03-04 11:44:17 -0500 |
| commit | 33b5eab7ab82a355629257f1b11fd9fcf4ff6f28 (patch) | |
| tree | de29231e3c141274006bb8ef0c2664ce6876321f /doc/src | |
| parent | 3bea3f88d5fc3517042ba83d2906979256da2442 (diff) | |
Fix the way GetExistingLocalJoinPath is documented.
The old approach made it look like it was an FDW callback, which it
is not.
Per a gripe from Stephen Frost. Patch by me, reviewed by Ashutosh
Bapat.
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/fdwhandler.sgml | 25 |
1 files changed, 7 insertions, 18 deletions
diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml index 9eec3c8da74..9ad4e1c9601 100644 --- a/doc/src/sgml/fdwhandler.sgml +++ b/doc/src/sgml/fdwhandler.sgml @@ -340,21 +340,6 @@ GetForeignJoinPaths (PlannerInfo *root, <para> See <xref linkend="fdw-planning"> for additional information. </para> - - <para> -<programlisting> -void -GetExistingLocalJoinPath(RelOptInfo *joinrel) -</programlisting> - The function returns copy of a local join path, which can be converted - into an alternative local join plan, which may be useful when - implementing a <literal>RecheckForeignScan</> method. The function - searches for an unparameterized path in the <literal>pathlist</> of given - <literal>joinrel</>. If it does not find such a path, it returns NULL, in - which case a foreign data wrapper may build the local path by itself or - may choose not to create access paths for that join. - </para> - </sect2> <sect2 id="fdw-callbacks-update"> @@ -808,9 +793,13 @@ RecheckForeignScan (ForeignScanState *node, TupleTableSlot *slot); can be executed and the resulting tuple can be stored in the slot. This plan need not be efficient since no base table will return more than one row; for example, it may implement all joins as nested loops. - <literal>GetExistingLocalJoinPath</> may be used to search existing paths - for a suitable local join path, which can be used as the alternative - local join plan. + The function <literal>GetExistingLocalJoinPath</> may be used to search + existing paths for a suitable local join path, which can be used as the + alternative local join plan. <literal>GetExistingLocalJoinPath</> + searches for an unparameterized path in the path list of the specified + join relation. (If it does not find such a path, it returns NULL, in + which case a foreign data wrapper may build the local path by itself or + may choose not to create access paths for that join.) </para> </sect2> |