【PHP8.x】Pdo\Sqlite::FETCH_LAZY定数の使い方

Copy
1<?php
2
3/**
4 * PDO::FETCH_LAZYの使用例
5 *
6 * PDO::FETCH_LAZYは、データベースからデータをフェッチする際に、
7 * 各行をPDORowオブジェクトとして返します。このオブジェクトは、
8 * プロパティがアクセスされたときに初めてその値をデータベースから読み込む（遅延ロードする）ため、
9 * 特に多くの列を持つテーブルや大きな結果セットを扱う場合に、メモリ効率が良い可能性があります。
10 */
11function demonstratePdoFetchLazy(): void
12{
13    // 1. SQLiteのインメモリデータベースに接続
14    // ':memory:' を使用することで、ディスク上にファイルを作成せず、スクリプト実行中にのみ存在するデータベースを作成します。
15    try {
16        $pdo = new PDO('sqlite::memory:');
17        // エラーモードを設定し、PDOがエラー発生時に例外をスローするようにします。
18        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
19        echo "Successfully connected to SQLite in-memory database.\n";
20    } catch (PDOException $e) {
21        // 接続に失敗した場合、エラーメッセージを表示してスクリプトを終了します。
22        die("Connection failed: " . $e->getMessage());
23    }
24
25    // 2. テスト用のテーブルを作成
26    $pdo->exec("CREATE TABLE IF NOT EXISTS products (
27        id INTEGER PRIMARY KEY AUTOINCREMENT,
28        name TEXT NOT NULL,
29        price REAL NOT NULL
30    )");
31    echo "Table 'products' created or already exists.\n";
32
33    // 3. サンプルデータを挿入
34    $stmt = $pdo->prepare("INSERT INTO products (name, price) VALUES (?, ?)");
35    $stmt->execute(['Laptop', 1200.50]);
36    $stmt->execute(['Mouse', 25.00]);
37    $stmt->execute(['Keyboard', 75.99]);
38    echo "Sample data inserted.\n";
39
40    // 4. データを選択するクエリを準備し、実行
41    $stmt = $pdo->prepare("SELECT id, name, price FROM products");
42    $stmt->execute();
43
44    echo "\nFetching results using PDO::FETCH_LAZY:\n";
45
46    // 5. PDO::FETCH_LAZYを使用してデータをフェッチし、表示
47    // 各行はPDORowオブジェクトとして返され、プロパティにアクセスするまで実際の値はロードされません。
48    while ($row = $stmt->fetch(PDO::FETCH_LAZY)) {
49        echo "Product ID: " . $row->id . "\n";
50        echo "Product Name: " . $row->name . "\n";
51        echo "Product Price: $" . $row->price . "\n";
52        echo "--------------------\n";
53    }
54
55    echo "Demonstration of PDO::FETCH_LAZY completed.\n";
56}
57
58// 関数を呼び出して実行
59demonstratePdoFetchLazy();
60
61?>

PHP 8のPDO::FETCH_LAZYは、データベースからデータを取得する際のフェッチモードを指定するPDO拡張の定数です。この定数を使用すると、PDOStatement::fetch()メソッドはデータベースの各行をPDORowオブジェクトとして返します。PDORowオブジェクトは、プロパティが実際にアクセスされるまで、その列の値をデータベースからメモリに読み込まない「遅延ロード」という特徴を持っています。これにより、特に大量の列を持つテーブルや非常に大きな結果セットを扱う場合に、不要なデータを一度にすべてメモリに展開せず、メモリ使用量を効率的に抑えることが可能となり、アプリケーションのパフォーマンス向上に貢献します。

このPDO::FETCH_LAZY定数自体に引数はなく、内部的には整数値が割り当てられています。PDOStatement::fetch()メソッドの引数としてこの定数を渡すことで、データ取得の挙動を制御します。サンプルコードでは、SQLiteのインメモリデータベースに接続し、作成したproductsテーブルからデータをPDO::FETCH_LAZYモードで取得しています。while ($row = $stmt->fetch(PDO::FETCH_LAZY))のループ内で、$rowにはPDORowオブジェクトが代入され、$row->idや$row->nameのようにプロパティにアクセスした時点で初めて該当するデータがデータベースからロードされる具体的な動作が示されており、効率的なデータアクセス方法を学ぶ上で参考になります。

Copy
1<?php
2
3/**
4 * PDO::FETCH_LAZY を使用してデータベースからデータをフェッチする方法を示す関数。
5 *
6 * PDO::FETCH_LAZY は、結果セットのカラムにアクセスするまで、オブジェクトのプロパティを
7 * オンデマンドで初期化するフェッチスタイルです。これにより、メモリ効率が向上する場合があります。
8 * この例では、SQLiteのインメモリデータベースを使用しています。
9 */
10function demonstratePdoFetchLazy(): void
11{
12    // SQLiteのインメモリデータベースに接続。スクリプト実行中にのみ存在します。
13    $databasePath = ':memory:';
14
15    try {
16        // 1. データベースに接続
17        // 'sqlite:' プレフィックスでSQLiteドライバーを指定します。
18        $pdo = new PDO('sqlite:' . $databasePath);
19
20        // PDOがエラー発生時に例外をスローするように設定
21        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
22        echo "データベースに接続しました。\n";
23
24        // 2. サンプルテーブルの作成
25        // ユーザー情報を格納する 'users' テーブルを作成します。
26        $pdo->exec("
27            CREATE TABLE IF NOT EXISTS users (
28                id INTEGER PRIMARY KEY AUTOINCREMENT,
29                name TEXT NOT NULL,
30                email TEXT NOT NULL UNIQUE
31            )
32        ");
33        echo "テーブル 'users' を作成しました (もし存在しない場合)。\n";
34
35        // 3. サンプルデータの挿入
36        // 既存データをクリアし、新しいユーザーデータを2件挿入します。
37        $pdo->exec("DELETE FROM users"); // デモンストレーションのため既存データを削除
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        echo "サンプルデータを挿入しました。\n";
41
42        // 4. データを選択し、PDO::FETCH_LAZY フェッチモードを使用
43        echo "\nPDO::FETCH_LAZY を使用してデータをフェッチします:\n";
44        $stmt = $pdo->query("SELECT id, name, email FROM users");
45
46        // PDOStatementオブジェクトにPDO::FETCH_LAZYフェッチモードを設定します。
47        // これにより、結果の各行が特別なオブジェクトとして返され、
48        // そのプロパティに初めてアクセスされるまで、実際の値の読み込みが遅延されます。
49        $stmt->setFetchMode(PDO::FETCH_LAZY);
50
51        // ループで結果セットから各行をフェッチ
52        while ($row = $stmt->fetch()) {
53            // $row はオブジェクトであり、カラム名がプロパティ名としてアクセスできます。
54            // ここで `$row->id` などにアクセスする際に、データがロードされます。
55            echo "--------------------\n";
56            echo "ID: " . $row->id . "\n";
57            echo "名前: " . $row->name . "\n";
58            echo "メール: " . $row->email . "\n";
59        }
60        echo "--------------------\n";
61        echo "データフェッチが完了しました。\n";
62
63    } catch (PDOException $e) {
64        // データベース関連のエラーをキャッチし、メッセージを表示
65        echo "データベースエラー: " . $e->getMessage() . "\n";
66    } catch (Exception $e) {
67        // その他のエラーをキャッチ
68        echo "一般エラー: " . $e->getMessage() . "\n";
69    }
70}
71
72// 関数を実行してデモンストレーションを開始
73demonstratePdoFetchLazy();

PHPのPDO::FETCH_LAZYは、データベースからデータを取得する際のフェッチモードを定義する定数です。引数なし、戻り値は整数型です。このモードを設定すると、結果セットの各行が特別なオブジェクトとして取得されます。そのプロパティ（データベースのカラム）は、実際にアクセスされるまでメモリにロードされません。これにより、必要なデータだけがオンデマンドで読み込まれ、特に大量のデータを扱う場合にメモリ使用量を効率化できます。

サンプルコードでは、SQLiteインメモリデータベースへの接続後、テーブル作成とデータ挿入を行い、PDOStatement::setFetchMode(PDO::FETCH_LAZY)でフェッチモードを設定しています。$stmt->fetch()で得られる$rowオブジェクトの$row->idや$row->nameといったプロパティにアクセスした時点で、初めて対応するカラムの値がロードされ表示されます。この動作は、データアクセスを遅延させ、リソースを効果的に利用するFETCH_LAZYの利点を示しています。