Skip to content

Commit

Permalink
Improve documentation of close_prepared/portal
Browse files Browse the repository at this point in the history
  • Loading branch information
larskanis committed Nov 24, 2024
1 parent 5d660c2 commit d583823
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion ext/pg_connection.c
Original file line number Diff line number Diff line change
Expand Up @@ -3604,8 +3604,9 @@ pgconn_async_describe_prepared(VALUE self, VALUE stmt_name)
* Submits a request to close the specified prepared statement, and waits for completion.
* close_prepared allows an application to close a previously prepared statement.
* Closing a statement releases all of its associated resources on the server and allows its name to be reused.
* It's the same as using the +DEALLOCATE+ SQL statement, but on a lower protocol level.
*
* statement_name can be "" or +nil+ to reference the unnamed statement.
* +statement_name+ can be "" or +nil+ to reference the unnamed statement.
* It is fine if no statement exists with this name, in that case the operation is a no-op.
* On success, a PG::Result with status PGRES_COMMAND_OK is returned.
*
Expand All @@ -3629,6 +3630,10 @@ pgconn_async_close_prepared(VALUE self, VALUE stmt_name)
* Closing a portal releases all of its associated resources on the server and allows its name to be reused.
* (pg does not provide any direct access to portals, but you can use this function to close a cursor created with a DECLARE CURSOR SQL command.)
*
* +portal_name+ can be "" or +nil+ to reference the unnamed portal.
* It is fine if no portal exists with this name, in that case the operation is a no-op.
* On success, a PG::Result with status PGRES_COMMAND_OK is returned.
*
* See also corresponding {libpq function}[https://www.postgresql.org/docs/current/libpq-exec.html#LIBPQ-PQCLOSEPORTAL].
*
* Available since PostgreSQL-17.
Expand Down

0 comments on commit d583823

Please sign in to comment.