PDOStatement::closeCursor

PDOStatement::closeCursor --
Closes the cursor, enabling the statement to be executed again.

Description

bool PDOStatement::closeCursor ( void )

PDOStatement::closeCursor() frees up the connection
to the server so that other SQL statements may be issued, but leaves the
statement in a state that enables it to be executed again.

This method is useful for database drivers that do not support executing
a PDOStatement object when a previously executed PDOStatement object still
has unfetched rows. If your database driver suffers from this limitation,
the problem may manifest itself in an out-of-sequence error.

PDOStatement::closeCursor() is implemented either as an
optional driver specific method (allowing for maximum efficiency), or as
the generic PDO fallback if no driver specific function is installed.
The PDO generic fallback is semantically the same as writing the following
code in your PHP script:

<?phpdo { while ($stmt->fetch()) ; if (!$stmt->nextRowset()) break;} while (true);?>

Examples

Example 1. A PDOStatement::closeCursor() example

In the following example, the $stmt PDOStatement
object returns multiple rows but the application fetches only the first
row, leaving the PDOStatement object in a state of having unfetched rows.
To ensure that the application will work with all database drivers, the
author inserts a call to PDOStatement::closeCursor()
on $stmt before executing the
$otherStmt PDOStatement object.