Commit319b6d2

Etsuro Fujita

authored and

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 parent83acb87 commit319b6d2Copy full SHA for 319b6d2

File tree

-5

lines changed

-5

lines changed

Lines changed: 8 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -1836,15 +1836,18 @@ typedef struct ForeignPath`
`1836`	`1836`	`}ForeignPath;`
`1837`	`1837`
`1838`	`1838`	`/*`
`1839`		`- * CustomPath represents a table scan done by some out-of-core extension.`
	`1839`	`+ * CustomPath represents a table scan or a table join done by some out-of-core`
	`1840`	`+ * extension.`
`1840`	`1841`	`*`
`1841`	`1842`	`* We provide a set of hooks here - which the provider must take care to set`
`1842`	`1843`	`* up correctly - to allow extensions to supply their own methods of scanning`
`1843`		`- * a relation. For example, a provider might provide GPU acceleration, a`
`1844`		`- * cache-based scan, or some other kind of logic we haven't dreamed up yet.`
	`1844`	`+ * a relation or joing relations. For example, a provider might provide GPU`
	`1845`	`+ * acceleration, a cache-based scan, or some other kind of logic we haven't`
	`1846`	`+ * dreamed up yet.`
`1845`	`1847`	`*`
`1846`		`- * CustomPaths can be injected into the planning process for a relation by`
`1847`		`- * set_rel_pathlist_hook functions.`
	`1848`	`+ * CustomPaths can be injected into the planning process for a base or join`
	`1849`	`+ * relation by set_rel_pathlist_hook or set_join_pathlist_hook functions,`
	`1850`	`+ * respectively.`
`1848`	`1851`	`*`
`1849`	`1852`	`* Core code must avoid assuming that the CustomPath is only as large as`
`1850`	`1853`	`* the structure declared here; providers are allowed to make it the first`

Comments

(0)