Thread: Feature: psql - display current search_path in prompt

Feature: psql - display current search_path in prompt

From
Lauri Siltanen
Date:
Hi all,

I need to switch search_paths often. It would be tremendously helpful to see the current search_path in the prompt.

-
Lauri Siltanen

Re: Feature: psql - display current search_path in prompt

From
Jelte Fennema-Nio
Date:
On Sat, 7 Jun 2025 at 20:52, Lauri Siltanen <lauri.siltanen@gmail.com> wrote:
> I need to switch search_paths often. It would be tremendously helpful to see the current search_path in the prompt.

That feature should be pretty easy to implement, now that search_path
is marked as GUC_REPORT in PG18. Basically you need to use
PQparameterStatus like we do for session_authorization[1][2].

[1]:
https://github.com/postgres/postgres/blob/73e26cbeb5927053eea4e209e5eda34a30c353f1/src/bin/psql/prompt.c#L166-L169
[2]:
https://github.com/postgres/postgres/blob/73e26cbeb5927053eea4e209e5eda34a30c353f1/src/bin/psql/common.c#L2508-L2520



Re: Feature: psql - display current search_path in prompt

From
Florents Tselai
Date:

> On 8 Jun 2025, at 2:36 AM, Jelte Fennema-Nio <postgres@jeltef.nl> wrote:
>
> On Sat, 7 Jun 2025 at 20:52, Lauri Siltanen <lauri.siltanen@gmail.com> wrote:
>> I need to switch search_paths often. It would be tremendously helpful to see the current search_path in the prompt.
>
> That feature should be pretty easy to implement, now that search_path
> is marked as GUC_REPORT in PG18. Basically you need to use
> PQparameterStatus like we do for session_authorization[1][2].
>
> [1]:
https://github.com/postgres/postgres/blob/73e26cbeb5927053eea4e209e5eda34a30c353f1/src/bin/psql/prompt.c#L166-L169
> [2]:
https://github.com/postgres/postgres/blob/73e26cbeb5927053eea4e209e5eda34a30c353f1/src/bin/psql/common.c#L2508-L2520
>
>


Here’s a quick attempt that makes %S substitue for a search_path
Like
 \set PROMPT1 'user:%n search_path: %S'




Attachment

Re: Feature: psql - display current search_path in prompt

From
Jelte Fennema-Nio
Date:
On Mon, 9 Jun 2025 at 17:54, Florents Tselai <florents.tselai@gmail.com> wrote:
> Here’s a quick attempt that makes %S substitue for a search_path
> Like
>  \set PROMPT1 'user:%n search_path: %S'

+   else
+       return PQuser(pset.db);

That seems like a copy paste error. If we don't have data for it, we
should either use the empty string, or some string like "<unknown>".

Other than that, the patch looks good (but I haven't tested it yet).



Re: Feature: psql - display current search_path in prompt

From
Florents Tselai
Date:

On Wed, Jun 11, 2025 at 1:01 PM Florents Tselai <florents.tselai@gmail.com> wrote:



On Wed, Jun 11, 2025 at 12:51 PM Jim Jones <jim.jones@uni-muenster.de> wrote:
On 10.06.25 15:37, Florents Tselai wrote:
> EDIT: There are test under `src/psql/t` , not sure though how much
> coverage they have,
> but most importantly how it’d look like for this case. 

I took a look at these files, but I'm still unsure how to use them for
automated prompt checking - I'm not super familiar with the perl tests,
to be honest.

From Tom at the discord channel 

 Yeah, you can see from the code coverage report [1] that session_username() isn't reached in our tests. It's only used if the psql prompt string is set to use it, and testing that in an interesting way is kind of hard --- our standard regression-script framework doesn't expose prompt output. On balance I'm not sure that covering session_username() would be worth the test cycles. [1] https://coverage.postgresql.org/src/bin/psql/common.c.gcov.html

So, yes I don't think we can auto-test it really, thus we'll have to rely on these simple functional tests.

 Absent any other feedback I'm marking this as Ready for Committer;
Said committer can push back on my arbitrary %S selection