【PHP8.x】PDOStatement::getIterator()メソッドの使い方

Copy
1<?php
2
3/**
4 * PDOStatement::getIterator() メソッドを使用して、データベースの結果セットをイテレートするサンプルコード。
5 *
6 * この関数は、インメモリのSQLiteデータベースを作成し、
7 * サンプルデータを挿入後、クエリ結果をPDOStatement::getIterator()で処理します。
8 *
9 * PDOStatement::getIterator() は、結果セットを反復処理するためのIteratorオブジェクトを返します。
10 * これにより、foreach ループでデータベースの行を効率的に取得できます。
11 */
12function iterateDatabaseRecordsWithPdoStatementIterator(): void
13{
14    // インメモリSQLiteデータベースを使用するため、ファイル作成は不要で、単体で動作します。
15    // ':memory:' は一時的なデータベースで、スクリプト終了時に破棄されます。
16    $dbDsn = 'sqlite::memory:';
17
18    try {
19        // 1. PDO接続を確立
20        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定することで、
21        // エラー発生時にPDOExceptionがスローされるようになります。
22        // PDO::ATTR_DEFAULT_FETCH_MODE を PDO::FETCH_ASSOC に設定することで、
23        // 結果セットが連想配列として取得されるようになります。
24        $pdo = new PDO($dbDsn);
25        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
26        $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);
27
28        echo "データベース接続に成功しました。\n";
29
30        // 2. サンプルテーブルを作成し、データを挿入
31        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
32            id INTEGER PRIMARY KEY AUTOINCREMENT,
33            name TEXT NOT NULL,
34            email TEXT UNIQUE NOT NULL
35        )");
36        echo "テーブル 'users' を作成しました。\n";
37
38        $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com')");
39        $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com')");
40        $pdo->exec("INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com')");
41        echo "サンプルデータを挿入しました。\n";
42
43        // 3. SQLクエリを実行し、PDOStatementオブジェクトを取得
44        $stmt = $pdo->query("SELECT id, name, email FROM users ORDER BY id");
45        echo "\n--- データベースの結果を PDOStatement::getIterator() で処理します ---\n";
46
47        // 4. PDOStatement::getIterator() を呼び出し、Iteratorオブジェクトを取得
48        // 5. foreach ループで取得したIteratorを使用し、結果セットを処理
49        $iterator = $stmt->getIterator();
50        $recordCount = 0;
51
52        foreach ($iterator as $row) {
53            $recordCount++;
54            echo "レコード {$recordCount}: ID=" . $row['id'] . ", 名前=" . $row['name'] . ", メール=" . $row['email'] . "\n";
55        }
56
57        if ($recordCount === 0) {
58            echo "該当するレコードは見つかりませんでした。\n";
59        }
60
61        echo "--- 処理完了 ---\n";
62
63    } catch (PDOException $e) {
64        // データベース関連のエラーをキャッチし、エラーメッセージを出力
65        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
66        error_log("PDO Error: " . $e->getMessage() . " in " . $e->getFile() . " on line " . $e->getLine());
67    } catch (Exception $e) {
68        // その他の予期せぬエラーをキャッチ
69        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
70        error_log("General Error: " . $e->getMessage() . " in " . $e->getFile() . " on line " . $e->getLine());
71    }
72}
73
74// 関数を実行
75iterateDatabaseRecordsWithPdoStatementIterator();

PDOStatement::getIterator() は、PHPのデータベース拡張機能であるPDO（PHP Data Objects）において、データベースクエリの実行結果を効率的に順次処理するためのメソッドです。このメソッドは引数を必要としません。

クエリを実行して得られた PDOStatement オブジェクトから getIterator() を呼び出すと、データベースの結果セットの各行を一つずつ反復処理できる Iterator オブジェクトが返されます。これにより、foreach ループを使って、結果セット全体を一度にメモリに読み込むことなく、必要な行だけを順次取り出して処理することが可能になります。これは、特に大量のデータを扱う際にメモリの消費を抑え、アプリケーションのパフォーマンスを向上させる上で非常に有用です。

サンプルコードでは、一時的なSQLiteデータベースを作成し、users テーブルにサンプルデータを挿入しています。その後、SELECT クエリを実行して得られた結果を PDOStatement::getIterator() で Iterator オブジェクトに変換し、foreach ループで各レコードのID、名前、メールアドレスを表示しています。この一連の流れは、データベースのデータをシンプルかつ効率的に取得し、アプリケーションで利用するための基本的なパターンを示しています。