pgsql: Add labels to help make psql's hidden queries more understandabl

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Add labels to help make psql's hidden queries more understandabl
Date: 2026-03-26 15:37:02
Message-ID: E1w5mlZ-001YlF-1E@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Add labels to help make psql's hidden queries more understandable.

We recommend looking at psql's "-E" output to help understand the
system catalogs, but in some cases (particularly table displays)
there's a bunch of rather impenetrable SQL there. As a small
improvement, label each query issued by describe.c with a short
description of its purpose. The code is arranged so that the
labels also appear as SQL comments in the server log, if the
server is logging these commands.

We could expand this policy to every use of PSQLexec(), but most of
the ones outside describe.c are issuing simple commands like "BEGIN"
or "COMMIT", which don't seem to need such glosses. I did add
labels to the commands issued by \sf, \sv and friends.

Also, make the -E and log output for hidden queries say
"INTERNAL QUERY" not just "QUERY", to distinguish them from
user-written queries.

Author: Greg Sabino Mullane <htamfids(at)gmail(dot)com>
Co-authored-by: David Christensen <david+pg(at)pgguru(dot)net>
Reviewed-by: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Discussion: https://postgr.es/m/CAKAnmmJz8Hh=8Ru8jgzySPWmLBhnv4=oc_0KRiz-UORJ0Dex+w@mail.gmail.com

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/41d69e6dccad6ef26511a466e6484bc8807362cf

Modified Files
--------------
src/bin/psql/command.c | 14 ++-
src/bin/psql/common.c | 4 +-
src/bin/psql/describe.c | 308 +++++++++++++++++++++++++++++++++---------------
3 files changed, 226 insertions(+), 100 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Robert Haas 2026-03-26 16:06:10 pgsql: pg_plan_advice: Refactor to invent pgpa_planner_info
Previous Message Andres Freund 2026-03-26 14:47:46 pgsql: Fix off-by-one error in read IO tracing