database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-05-06 19:59:18 +03:00
Code

Update comments on CustomPath struct.

Browse Source 
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
This commit is contained in:
Etsuro Fujita 2023-08-03 17:15:02 +09:00
parent c6344d7686
commit 9f495270cc
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/include/nodes/pathnodes.h
View File

@ -1403,15 +1403,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