Update Help on PREPARE to mention DEALLOCATE

From: Kirk Wolak <wolakk(at)gmail(dot)com>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Update Help on PREPARE to mention DEALLOCATE
Date: 2024-04-16 20:27:08
Message-ID: CACLU5mRsdYaEr+y=rYr6_rHJRoW49vTnSLdrcwwN2K0fONupJg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Please notice this exchange:

16:20:02 devuser(at)nctest= # \h deallocate
Command: DEALLOCATE
Description: deallocate a prepared statement
Syntax:
DEALLOCATE [ PREPARE ] { name | ALL }

URL: https://www.postgresql.org/docs/16/sql-deallocate.html

16:20:11 devuser(at)nctest= # \h PREPARE
Command: PREPARE
Description: prepare a statement for execution
Syntax:
PREPARE name [ ( data_type [, ...] ) ] AS statement

URL: https://www.postgresql.org/docs/16/sql-prepare.html

Notice. The DEALLOCATE shows [ PREPARE ]
Which is great because the two commands go together.
Unfortunately it's asymmetry is painful. Because I ALWAYS remember PREPARE.
It's DEALLOCATE I always struggle to remember.

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?

Thanks!

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message David G. Johnston 2024-04-16 20:42:21 Re: Update Help on PREPARE to mention DEALLOCATE
Previous Message Pavel Luzanov 2024-04-16 10:42:37 pg_createsubscriber: A more precise link to the initial data sync