Missing comments/docs about custom scan path

Etsuro Fujita <etsuro.fujita@gmail.com>

From: Etsuro Fujita <etsuro.fujita@gmail.com>

To: Pg Hackers <pgsql-hackers@postgresql.org>

Date: 2023-07-31T10:05:02Z

Lists: pgsql-hackers

Attachments

update-custom-scan-path-comments.patch (application/octet-stream) patch
update-custom-scan-path-docs.patch (application/octet-stream) patch

Hi,

While working on [1], I noticed $SUBJECT: commit e7cb7ee14 failed to
update comments for the CustomPath struct in pathnodes.h, and commit
f49842d1e failed to update docs about custom scan path callbacks in
custom-scan.sgml, IIUC.  Attached are patches for updating these,
which I created separately for ease of review (patch
update-custom-scan-path-comments.patch for the former and patch
update-custom-scan-path-docs.patch for the latter).  In the second
patch I used almost the same text as for the
ReparameterizeForeignPathByChild callback function in fdwhandler.sgml.

Best regards,
Etsuro Fujita

[1] https://www.postgresql.org/message-id/CAPmGK16ah9JtyVPtdqu6d%3DQGkRX%3DRAzoYQfX7%3DLZ%2BKnqwBfftg%40mail.gmail.com

Commits

Doc: Improve documentation for creating custom scan paths.
- 7ef5f5fb3240 17.0 landed
Doc: update documentation for creating custom scan paths.
- 0a1ff1d724e8 11.21 landed
- 9528ae1a1855 12.16 landed
- cc20236d15b3 13.12 landed
- 1ecd74396902 14.9 landed
- dea12a1fd4fd 15.4 landed
- f0a3805d7c44 16.0 landed
- 74a2dfee2255 17.0 landed
Update comments on CustomPath struct.
- db395e2239a2 11.21 landed
- 329f3a4bbab1 12.16 landed
- 4eb8b9c28256 13.12 landed
- 1ea0424a5b8e 14.9 landed
- 9f495270cca7 15.4 landed
- c575e00230ed 16.0 landed
- 20f90a0e4d86 17.0 landed
Basic partition-wise join functionality.
- f49842d1ee31 11.0 cited
Allow FDWs and custom scan providers to replace joins with scans.
- e7cb7ee14555 9.5.0 cited