database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-28 23:42:10 +03:00
Code Activity

Fix the way GetExistingLocalJoinPath is documented.

Browse Source 
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.
This commit is contained in:
Robert Haas
2016-03-04 11:41:23 -05:00
parent 3bea3f88d5
commit 33b5eab7ab
1 changed files with 7 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/src/sgml/fdwhandler.sgml
View File

@ -340,21 +340,6 @@ GetForeignJoinPaths (PlannerInfo *root,
<para> <para>
See <xref linkend="fdw-planning"> for additional information. See <xref linkend="fdw-planning"> for additional information.
</para> </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>
<sect2 id="fdw-callbacks-update"> <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. 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 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. than one row; for example, it may implement all joins as nested loops.
<literal>GetExistingLocalJoinPath</> may be used to search existing paths The function <literal>GetExistingLocalJoinPath</> may be used to search
for a suitable local join path, which can be used as the alternative existing paths for a suitable local join path, which can be used as the
local join plan. 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> </para>
</sect2> </sect2>