Commit1ea0424

Etsuro Fujita

committed

Update comments on CustomPath struct.

Commite7cb7ee allowed custom scan providers to create CustomPathpaths 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

1 parent2e3741f commit1ea0424Copy full SHA for 1ea0424

File tree

-5

lines changed

-5

lines changed

Lines changed: 8 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -1398,15 +1398,18 @@ typedef struct ForeignPath`
`1398`	`1398`	`}ForeignPath;`
`1399`	`1399`
`1400`	`1400`	`/*`
`1401`		`- * CustomPath represents a table scan done by some out-of-core extension.`
	`1401`	`+ * CustomPath represents a table scan or a table join done by some out-of-core`
	`1402`	`+ * extension.`
`1402`	`1403`	`*`
`1403`	`1404`	`* We provide a set of hooks here - which the provider must take care to set`
`1404`	`1405`	`* up correctly - to allow extensions to supply their own methods of scanning`
`1405`		`- * a relation. For example, a provider might provide GPU acceleration, a`
`1406`		`- * cache-based scan, or some other kind of logic we haven't dreamed up yet.`
	`1406`	`+ * a relation or joing relations. For example, a provider might provide GPU`
	`1407`	`+ * acceleration, a cache-based scan, or some other kind of logic we haven't`
	`1408`	`+ * dreamed up yet.`
`1407`	`1409`	`*`
`1408`		`- * CustomPaths can be injected into the planning process for a relation by`
`1409`		`- * set_rel_pathlist_hook functions.`
	`1410`	`+ * CustomPaths can be injected into the planning process for a base or join`
	`1411`	`+ * relation by set_rel_pathlist_hook or set_join_pathlist_hook functions,`
	`1412`	`+ * respectively.`
`1410`	`1413`	`*`
`1411`	`1414`	`* Core code must avoid assuming that the CustomPath is only as large as`
`1412`	`1415`	`* the structure declared here; providers are allowed to make it the first`

Comments

(0)