pgsql: Fix pg_overexplain to emit valid output with RANGE_TABLE option.

From: Amit Langote <amitlan(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Fix pg_overexplain to emit valid output with RANGE_TABLE option.
Date: 2026-04-16 05:16:23
Message-ID: E1wDF5T-001CQH-0L@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Fix pg_overexplain to emit valid output with RANGE_TABLE option.

overexplain_range_table() emitted the "Unprunable RTIs" and "Result
RTIs" properties before closing the "Range Table" group. In the JSON
and YAML formats the Range Table group is rendered as an array of RTE
objects, so emitting key/value pairs inside it produced structurally
invalid output. The XML format had a related oddity, with these
elements nested inside <Range-Table> rather than appearing as its
siblings.

These fields are properties of the PlannedStmt as a whole, not of any
individual RTE, so close the Range Table group before emitting them.
They now appear as siblings of "Range Table" in the parent Query
object, which is what was intended.

Also add a test exercising FORMAT JSON with RANGE_TABLE so that any
future regression in the output structure is caught.

Reported-by: Satyanarayana Narlapuram <satyanarlapuram(at)gmail(dot)com>
Author: Satyanarayana Narlapuram <satyanarlapuram(at)gmail(dot)com>
Reviewed-by: Amit Langote <amitlangote09(at)gmail(dot)com>
Reviewed-by: Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com>
Discussion: https://postgr.es/m/CAHg+QDdDrdqMr98a_OBYDYmK3RaT7XwCEShZfvDYKZpZTfOEjQ@mail.gmail.com
Backpatch-through: 18

Branch
------
REL_18_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/6723d462db5a9ecea840b946f6b2843c20b1c866

Modified Files
--------------
contrib/pg_overexplain/expected/pg_overexplain.out | 121 ++++++++++++++++++++-
contrib/pg_overexplain/pg_overexplain.c | 12 +-
contrib/pg_overexplain/sql/pg_overexplain.sql | 6 +
3 files changed, 133 insertions(+), 6 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Amit Langote 2026-04-16 05:16:37 pgsql: Fix pg_overexplain to emit valid output with RANGE_TABLE option.
Previous Message Amit Langote 2026-04-16 04:45:51 pgsql: Fix incorrect comment in JsonTablePlanJoinNextRow()