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

Commit 7ef5f5f

Browse files
author
Etsuro Fujita
committed
Doc: Improve documentation for creating custom scan paths.
This improves the documentation related to parallel query a little bit. Reviewed by Richard Guo. Discussion: https://postgr.es/m/CAPmGK159eJShAR4ek4Db8oHD4%2BZ18zwJkisEWkqRN-80BdDGFQ%40mail.gmail.com
1 parent 05c8212 commit 7ef5f5f

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/src/sgml/custom-scan.sgml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
A custom scan provider will typically add paths for a base relation by
3939
setting the following hook, which is called after the core code has
4040
generated all the access paths it can for the relation (except for
41-
Gather paths, which are made after this call so that they can use
42-
partial paths added by the hook):
41+
Gather and Gather Merge paths, which are made after this call so that
42+
they can use partial paths added by the hook):
4343
<programlisting>
4444
typedef void (*set_rel_pathlist_hook_type) (PlannerInfo *root,
4545
RelOptInfo *rel,
@@ -53,9 +53,10 @@ extern PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook;
5353
Although this hook function can be used to examine, modify, or remove
5454
paths generated by the core system, a custom scan provider will typically
5555
confine itself to generating <structname>CustomPath</structname> objects and adding
56-
them to <literal>rel</literal> using <function>add_path</function>. The custom scan
57-
provider is responsible for initializing the <structname>CustomPath</structname>
58-
object, which is declared like this:
56+
them to <literal>rel</literal> using <function>add_path</function>, or
57+
<function>add_partial_path</function> if they are partial paths. The
58+
custom scan provider is responsible for initializing the
59+
<structname>CustomPath</structname> object, which is declared like this:
5960
<programlisting>
6061
typedef struct CustomPath
6162
{

0 commit comments

Comments
 (0)