From c575e00230ed1262edb7845e2e9a22ec164bf9f0 Mon Sep 17 00:00:00 2001 From: Etsuro Fujita Date: Thu, 3 Aug 2023 17:15:01 +0900 Subject: [PATCH] Update comments on CustomPath struct. Commit e7cb7ee14 allowed custom scan providers to create CustomPath paths for join relations as well, but missed updating the comments. Back-patch to all supported branches. Discussion: https://postgr.es/m/CAPmGK15ODkN%2B%3DhkBCufj1HBW0x5OTb65Xuy7ryXchMdiCMpx_g%40mail.gmail.com --- src/include/nodes/pathnodes.h | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/include/nodes/pathnodes.h b/src/include/nodes/pathnodes.h index c17b53f7ad..a1dc1d07e1 100644 --- a/src/include/nodes/pathnodes.h +++ b/src/include/nodes/pathnodes.h @@ -1836,15 +1836,18 @@ typedef struct ForeignPath } ForeignPath; /* - * CustomPath represents a table scan done by some out-of-core extension. + * CustomPath represents a table scan or a table join done by some out-of-core + * extension. * * We provide a set of hooks here - which the provider must take care to set * up correctly - to allow extensions to supply their own methods of scanning - * a relation. For example, a provider might provide GPU acceleration, a - * cache-based scan, or some other kind of logic we haven't dreamed up yet. + * a relation or joing relations. For example, a provider might provide GPU + * acceleration, a cache-based scan, or some other kind of logic we haven't + * dreamed up yet. * - * CustomPaths can be injected into the planning process for a relation by - * set_rel_pathlist_hook functions. + * CustomPaths can be injected into the planning process for a base or join + * relation by set_rel_pathlist_hook or set_join_pathlist_hook functions, + * respectively. * * Core code must avoid assuming that the CustomPath is only as large as * the structure declared here; providers are allowed to make it the first