PDOStatement::closeCursor

PHP PDO 参考手册PHP PDO リファレンスマニュアル

PDOStatement::closeCursor — カーソルを閉じて、ステートメントを再実行できるようにします。(PHP 5 >= 5.1.0, PECL pdo >= 0.9.0)


説明

構文

bool PDOStatement::closeCursor ( void )

PDOStatement::closeCursor() は、データベースサービスへの接続を解放して他の SQL ステートメントを発行できるようにしますが、ステートメントは再実行可能な状態のままになります。

前回実行した PDOStatement オブジェクトに未取得の行が残っている場合、このメソッドは PDOStatement オブジェクトの再実行をサポートしていないデータベースドライバに非常に役立ちます。データベースドライバがこの制限を受ける場合、順序が狂ったエラーが発生する可能性があります。

PDOStatement::closeCursor() は、ドライバ固有のメソッド(最も効率的)として実装されるか、ドライバ固有の機能がない場合は一般的な PDO フォールバックとして実装されます。一般的なフォールバックは、意味的には以下の PHP コードと同じです:

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

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。


例

PDOStatement::closeCursor() の例

以下の例では、$stmt PDOStatement オブジェクトは複数行を返しますが、アプリケーションは最初の行のみを取得するため、PDOStatement オブジェクトは未取得の行がある状態になります。アプリケーションがすべてのデータベースドライバで正しく動作するようにするには、$otherStmt PDOStatement オブジェクトを実行する前に、$stmt で PDOStatement::closeCursor() を一度呼び出します。

<?php
/* 创建一个 PDOStatement 对象 */
$stmt = $dbh->prepare('SELECT foo FROM bar');

/* 创建第二个 PDOStatement 对象 */
$otherStmt = $dbh->prepare('SELECT foobaz FROM foobar');

/* 执行第一条语句 */
$stmt->execute();

/*  从结果集中只取出第一行 */
$stmt->fetch();

/* The following call to closeCursor() may be required by some drivers */
$stmt->closeCursor();

/*  现在可以执行第二条语句了 */
$otherStmt->execute();
?>

PHP PDO 参考手册PHP PDO リファレンスマニュアル

その他の拡張