Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 33b5eab

Browse files
committed
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.
1 parent 3bea3f8 commit 33b5eab

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

doc/src/sgml/fdwhandler.sgml

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -340,21 +340,6 @@ GetForeignJoinPaths (PlannerInfo *root,
340340
<para>
341341
See <xref linkend="fdw-planning"> for additional information.
342342
</para>
343-
344-
<para>
345-
<programlisting>
346-
void
347-
GetExistingLocalJoinPath(RelOptInfo *joinrel)
348-
</programlisting>
349-
The function returns copy of a local join path, which can be converted
350-
into an alternative local join plan, which may be useful when
351-
implementing a <literal>RecheckForeignScan</> method. The function
352-
searches for an unparameterized path in the <literal>pathlist</> of given
353-
<literal>joinrel</>. If it does not find such a path, it returns NULL, in
354-
which case a foreign data wrapper may build the local path by itself or
355-
may choose not to create access paths for that join.
356-
</para>
357-
358343
</sect2>
359344

360345
<sect2 id="fdw-callbacks-update">
@@ -808,9 +793,13 @@ RecheckForeignScan (ForeignScanState *node, TupleTableSlot *slot);
808793
can be executed and the resulting tuple can be stored in the slot.
809794
This plan need not be efficient since no base table will return more
810795
than one row; for example, it may implement all joins as nested loops.
811-
<literal>GetExistingLocalJoinPath</> may be used to search existing paths
812-
for a suitable local join path, which can be used as the alternative
813-
local join plan.
796+
The function <literal>GetExistingLocalJoinPath</> may be used to search
797+
existing paths for a suitable local join path, which can be used as the
798+
alternative local join plan. <literal>GetExistingLocalJoinPath</>
799+
searches for an unparameterized path in the path list of the specified
800+
join relation. (If it does not find such a path, it returns NULL, in
801+
which case a foreign data wrapper may build the local path by itself or
802+
may choose not to create access paths for that join.)
814803
</para>
815804
</sect2>
816805

0 commit comments

Comments
 (0)