Re: Update Help on PREPARE to mention DEALLOCATE

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Kirk Wolak <wolakk(at)gmail(dot)com>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Update Help on PREPARE to mention DEALLOCATE
Date: 2024-04-16 20:42:21
Message-ID: CAKFQuwa0CdWC2wsaGBdiBd22AvOShy=qnDU-fpkNj_3cfc8RzQ@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Tue, Apr 16, 2024 at 1:27 PM Kirk Wolak <wolakk(at)gmail(dot)com> wrote:

> Could we make the PREPARE line read
>
> PREPARE [ DEALLOCATE ] ...?
>
> So it's more consistent, and the user using a PREPARE gets a clue to
> DEALLOCATE?
>
>
No. That is a syntax excerpt and the prepare command doesn't accept an
optional deallocate keyword at that position.

If we wanted to improve the psql help here we'd have two options:
Add to the description:
prepare a statement for execution (undo this with Deallocate)

or teach our build system to add our "see also" section to the psql help
pages.

The second seems reasonable but non-trivial. The first just seems odd when
reading the website.

There may be a third option but I actually haven't ever explored the psql
help build module.

David J.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Kirk Wolak 2024-04-17 17:52:57 Re: Update Help on PREPARE to mention DEALLOCATE
Previous Message Kirk Wolak 2024-04-16 20:27:08 Update Help on PREPARE to mention DEALLOCATE