pgsql: psql: Add pipeline status to prompt and some state variables

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: psql: Add pipeline status to prompt and some state variables
Date: 2025-02-25 01:08:48
Message-ID: E1tmjRH-000XTC-2X@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

psql: Add pipeline status to prompt and some state variables

This commit adds %P to psql prompts, able to report the status of a
pipeline depending on PQpipelineStatus(): on, off or abort.

The following variables are added to report the state of an ongoing
pipeline:
- PIPELINE_SYNC_COUNT: reports the number of piped syncs.
- PIPELINE_COMMAND_COUNT: reports the number of piped commands, a
command being either \bind, \bind_named, \close or \parse.
- PIPELINE_RESULT_COUNT: reports the results available to read with
\getresults.

These variables can be used with \echo or in a prompt, using "%:name:"
in PROMPT1, PROMPT2 or PROMPT3. Some basic regression tests are added
for these. The suggestion to use variables to show the details about
the status counters comes from me. The original patch proposed was less
extensible, hardcoding the output in the prompt.

Author: Anthonin Bonnefoy <anthonin(dot)bonnefoy(at)datadoghq(dot)com>
Discussion: https://postgr.es/m/CAO6_XqroE7JuMEm1sWz55rp9fAYX2JwmcP_3m_v51vnOFdsLiQ@mail.gmail.com

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/3ce357584e795762aa6dc45fafc21dccea7e5ec6

Modified Files
--------------
doc/src/sgml/ref/psql-ref.sgml | 50 +++++++++++++++++++++++++++++
src/bin/psql/common.c | 27 +++++++++++++++-
src/bin/psql/prompt.c | 14 ++++++++
src/bin/psql/startup.c | 5 +++
src/test/regress/expected/psql_pipeline.out | 22 +++++++++++++
src/test/regress/sql/psql_pipeline.sql | 11 +++++++
6 files changed, 128 insertions(+), 1 deletion(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Jeff Davis 2025-02-25 01:12:26 pgsql: Do not use in-place updates for statistics import.
Previous Message Amit Langote 2025-02-25 00:27:40 pgsql: Fix bug in cbc127917 to handle nested Append correctly