Re: Update Help on PREPARE to mention DEALLOCATE - Mailing list pgsql-docs

From David G. Johnston
Subject Re: Update Help on PREPARE to mention DEALLOCATE
Date
Msg-id CAKFQuwa0CdWC2wsaGBdiBd22AvOShy=qnDU-fpkNj_3cfc8RzQ@mail.gmail.com
Whole thread Raw
In response to Update Help on PREPARE to mention DEALLOCATE  (Kirk Wolak <wolakk@gmail.com>)
Responses Re: Update Help on PREPARE to mention DEALLOCATE
List pgsql-docs
On Tue, Apr 16, 2024 at 1:27 PM Kirk Wolak <wolakk@gmail.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.
 

pgsql-docs by date:

Previous
From: Kirk Wolak
Date:
Subject: Update Help on PREPARE to mention DEALLOCATE
Next
From: Kirk Wolak
Date:
Subject: Re: Update Help on PREPARE to mention DEALLOCATE