php8.5
Home/ Manual/ pgsql / functions/ pg_close_stmt

pg_close_stmt

PHP function Edit on GitHub ✎

(PHP 8 >= 8.5.0)

Closes a prepared statement

Description

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

Connection

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

Source: reference/pgsql/functions/pg-close-stmt.xml · from the official PHP manual (php/doc-en)