[PATCH] doc: outline all planner nodes

Lists: pgsql-docs
From: TheOtherBrian1 <briantgbtheonly(at)gmail(dot)com>
To: pgsql-docs(at)postgresql(dot)org
Cc: TheOtherBrian1 <brian(at)supabase(dot)io>
Subject: [PATCH] doc: outline all planner nodes
Date: 2026-07-06 02:09:02
Message-ID: 20260706020904.565177-1-briantgbtheonly@gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Lists: pgsql-docs


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(-)

Attachment Content-Type Size
0001-doc-outline-all-planner-nodes.patch text/x-patch 72.2 KB

From: TheOtherBrian1 <briantgbtheonly(at)gmail(dot)com>
To: brian(at)supabase(dot)io
Cc: pgsql-docs(at)postgresql(dot)org, TheOtherBrian1 <briantgbtheonly(at)gmail(dot)com>
Subject: Re: [PATCH] doc: outline all planner nodes
Date: 2026-07-19 00:26:30
Message-ID: 20260719002640.860035-1-briantgbtheonly@gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Lists: pgsql-docs


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(-)

Attachment Content-Type Size
0001-doc-outline-all-planner-nodes.patch text/x-patch 73.0 KB

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: TheOtherBrian1 <briantgbtheonly(at)gmail(dot)com>
Cc: brian(at)supabase(dot)io, pgsql-docs(at)postgresql(dot)org
Subject: Re: [PATCH] doc: outline all planner nodes
Date: 2026-07-19 19:56:32
Message-ID: EBDE5A52-E5E7-4016-93AC-BEFE75C850CC@yesql.se
Views: Whole Thread | Raw Message | Download mbox | Resend email
Lists: pgsql-docs

> On 19 Jul 2026, at 02:26, TheOtherBrian1 <briantgbtheonly(at)gmail(dot)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


From: TheOtherBrian1 <briantgbtheonly(at)gmail(dot)com>
To: daniel(at)yesql(dot)se
Cc: pgsql-docs(at)postgresql(dot)org, TheOtherBrian1 <briantgbtheonly(at)gmail(dot)com>
Subject: [PATCH v2] doc: outline all planner nodes
Date: 2026-07-21 03:14:17
Message-ID: 20260721031608.908775-1-briantgbtheonly@gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Lists: pgsql-docs


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(-)

Attachment Content-Type Size
v2-0001-doc-outline-all-planner-nodes.patch text/x-patch 73.0 KB