[PATCH] doc: outline all planner nodes

Started by TheOtherBrian13 months ago4 messagesdocs
Beta feature

Hackorum builds and tests every patch posted to the lists, not only commitfest submissions. This is Hackorum's own CI rather than the PostgreSQL project's, and it is still under testing - please report anything that looks wrong.

never appliedCI history
Jump to latest
#1TheOtherBrian1
briantgbtheonly@gmail.com

Hi,

The docs doesn't currently list all the planner nodes. I wrote a patch to add a new section "14.3" that outlines the different types.

I took the compiled HTML page and hosted it on Netlify to make it easier to peruse:
- https://lovely-lebkuchen-c79301.netlify.app/

Apologies if this isn't formatted normally. This is my first time contributing to the PG project directly.

Best,
Brian B.
Supabase Customer Reliability Engineer

---
doc/src/sgml/perform.sgml | 2248 ++++++++++++++++++++++++++++++++-
doc/src/sgml/ref/explain.sgml | 2 +-
2 files changed, 2247 insertions(+), 3 deletions(-)

Attachments:

0001-doc-outline-all-planner-nodes.patchtext/x-patch; name=0001-doc-outline-all-planner-nodes.patchDownload+2247-3
#2TheOtherBrian1
briantgbtheonly@gmail.com
In reply to: TheOtherBrian1 (#1)
Re: [PATCH] doc: outline all planner nodes

The original patch was updated to:
- improve language
- add an example for CTE Scans
- fix inaccuracy around Index-Only Scans
- remove typos

Including a link to a preview version of the new page:
- https://celebrated-banoffee-1d6ed3.netlify.app/

---
doc/src/sgml/perform.sgml | 2262 ++++++++++++++++++++++++++++++++-
doc/src/sgml/ref/explain.sgml | 2 +-
2 files changed, 2260 insertions(+), 4 deletions(-)

Attachments:

0001-doc-outline-all-planner-nodes.patchtext/x-patch; name=0001-doc-outline-all-planner-nodes.patchDownload+2260-4
#3Daniel Gustafsson
daniel@yesql.se
In reply to: TheOtherBrian1 (#2)
Re: [PATCH] doc: outline all planner nodes

On 19 Jul 2026, at 02:26, TheOtherBrian1 <briantgbtheonly@gmail.com> wrote:

The original patch was updated to:
- improve language
- add an example for CTE Scans
- fix inaccuracy around Index-Only Scans
- remove typos

I didn't see this registered in the commitfest app, if it is there I simply
failed to search for it. If not, please register it there to keep it top of
mind when work on finalizing v19 slows down.

https://commitfest.postgresql.org/61/

--
Daniel Gustafsson

#4TheOtherBrian1
briantgbtheonly@gmail.com
In reply to: Daniel Gustafsson (#3)
[PATCH v2] doc: outline all planner nodes

Added a full list of the nodes with examples
to Section 14.3. Instead of explicitly outlining all parallel nodes, a reference was instead added to "15.3. Parallel Plans".

The original patch was updated to:
- improve language
- add an example for CTE Scans
- fix inaccuracy around Index-Only Scans
- remove typos
---

Sorry about the confusion. Added the patch to commitfest.

Brian B.
---
doc/src/sgml/perform.sgml | 2262 ++++++++++++++++++++++++++++++++-
doc/src/sgml/ref/explain.sgml | 2 +-
2 files changed, 2260 insertions(+), 4 deletions(-)

Attachments:

v2-0001-doc-outline-all-planner-nodes.patchtext/x-patch; name=v2-0001-doc-outline-all-planner-nodes.patchDownload+2260-4