PHP Conference Ehime 2026

pg_close_stmt

(PHP 8 >= 8.5.0)

pg_close_stmtCloses a prepared statement

Description

function pg_close_stmt(PgSql\Connection $connection, string $statement_name): PgSql\Result|false

Closes a prepared statement on the server, freeing its resources and making its name available for reuse. It is an alternative to issuing a DEALLOCATE SQL command, which does not allow the statement name to be reused afterwards.

This function is only available if PHP has been built against libpq 17 or later.

Parameters

connection

An PgSql\Connection instance.

statement_name

The name of the prepared statement to close.

Return Values

A PgSql\Result instance on success, or false on failure.

Errors/Exceptions

Throws a ValueError if statement_name is empty or contains any null bytes.

See Also

  • pg_prepare() - Submits a request to the server to create a prepared statement with the given parameters, and waits for completion
  • pg_execute() - Sends a request to execute a prepared statement with given parameters, and waits for the result
add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top