Skip to content

Commit

Permalink
Doc: Improve documentation for creating custom scan paths.
Browse files Browse the repository at this point in the history
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
  • Loading branch information
Etsuro Fujita committed Aug 30, 2023
1 parent 05c8212 commit 7ef5f5f
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions doc/src/sgml/custom-scan.sgml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
A custom scan provider will typically add paths for a base relation by
setting the following hook, which is called after the core code has
generated all the access paths it can for the relation (except for
Gather paths, which are made after this call so that they can use
partial paths added by the hook):
Gather and Gather Merge paths, which are made after this call so that
they can use partial paths added by the hook):
<programlisting>
typedef void (*set_rel_pathlist_hook_type) (PlannerInfo *root,
RelOptInfo *rel,
Expand All @@ -53,9 +53,10 @@ extern PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook;
Although this hook function can be used to examine, modify, or remove
paths generated by the core system, a custom scan provider will typically
confine itself to generating <structname>CustomPath</structname> objects and adding
them to <literal>rel</literal> using <function>add_path</function>. The custom scan
provider is responsible for initializing the <structname>CustomPath</structname>
object, which is declared like this:
them to <literal>rel</literal> using <function>add_path</function>, or
<function>add_partial_path</function> if they are partial paths. The
custom scan provider is responsible for initializing the
<structname>CustomPath</structname> object, which is declared like this:
<programlisting>
typedef struct CustomPath
{
Expand Down

0 comments on commit 7ef5f5f

Please sign in to comment.