PDOStatement::closeCursor

    (PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.9.0)

    PDOStatement::closeCursor — カーソルを閉じてステートメントを再実行できるようにする

    説明

    publicPDOStatement::closeCursor(): bool

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

    このメソッドは以前に実行された PDOStatement オブジェクトが行をまだフェッチしていない場合に PDOStatement オブジェクトの実行をサポートしていないデータベースドライバに対して有用です。 もし使用しているデータベースドライバがこの制限を受ける場合、 out-of-sequence エラーが出力されます。

    PDOStatement::closeCursor() は、 オプションのドライバ固有のメソッド (最大の効率を得るため) もしくはドライバ固有の関数がインストールされていない場合の汎用的な PDO フォールバックとして実装されています。 汎用的な PDO フォールバックは、PHP スクリプト中に以下のようなコードを書くことと意味的に等価です。

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

    パラメータ

    この関数にはパラメータはありません。

    戻り値

    成功した場合に true を、失敗した場合に false を返します。

    エラー / 例外

    PDO::ATTR_ERRMODE が PDO::ERRMODE_WARNING に設定されていた場合、E_WARNING レベルのエラーが発生します。

    PDO::ATTR_ERRMODE が PDO::ERRMODE_EXCEPTION に設定されていた場合、PDOException がスローされます。

    例

    例1 PDOStatement::closeCursor() の例

    以下の例では、PDOStatement オブジェクト $stmt は複数の行を返しますが、このアプリケーションは先頭行のみフェッチし、 PDOStatement オブジェクトをフェッチしていない行がある状態のままにします。 このアプリケーションがが全てのデータベースドライバで動作するよう、 PDOStatement オブジェクト $otherStmt を実行する前に $stmt に対して PDOStatement::closeCursor() の呼び出しを挿入しています。

    <?php

    $stmt = $dbh->prepare('SELECT foo FROM bar');


    $otherStmt = $dbh->prepare('SELECT foobaz FROM foobar');


    $stmt->execute();


    $stmt->fetch();


    $stmt->closeCursor();


    $otherStmt->execute();
    ?>

    参考

    To Top