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

Copy
1<?php
2
3/**
4 * PDOStatement::nextRowset() メソッドの動作を示すサンプルコード。
5 *
6 * この関数は、MySQLデータベースに接続し、複数のSELECT文を含む単一のSQLクエリを実行します。
7 * PDOStatement::nextRowset() メソッドを使用して、返された複数の結果セット間を移動し、
8 * それぞれの結果セットからデータを取得して表示します。
9 *
10 * 実行前の準備:
11 * 1. MySQLデータベースが稼働していること。
12 * 2. 以下の設定でデータベースとテーブル、サンプルデータが作成されていること。
13 *    - データベース名: `test_db`
14 *    - データベースユーザー名とパスワード (以下のコードの `$user`, `$password` に合わせる)
15 *    - `test_db` 内に `users` テーブルと `products` テーブルが存在し、データが挿入されていること。
16 *
17 *    SQLサンプルスクリプト:
18 *    CREATE DATABASE IF NOT EXISTS test_db;
19 *    USE test_db;
20 *    CREATE TABLE IF NOT EXISTS users (
21 *        id INT AUTO_INCREMENT PRIMARY KEY,
22 *        name VARCHAR(255) NOT NULL
23 *    );
24 *    INSERT INTO users (name) VALUES ('Alice'), ('Bob');
25 *
26 *    CREATE TABLE IF NOT EXISTS products (
27 *        id INT AUTO_INCREMENT PRIMARY KEY,
28 *        name VARCHAR(255) NOT NULL,
29 *        price DECIMAL(10, 2) NOT NULL
30 *    );
31 *    INSERT INTO products (name, price) VALUES ('Laptop', 1200.00), ('Mouse', 25.00);
32 */
33function demonstratePdoNextRowset(): void
34{
35    // データベース接続情報の設定
36    $dsn = 'mysql:host=localhost;dbname=test_db;charset=utf8mb4';
37    $user = 'root'; // あなたのデータベースユーザー名を設定してください
38    $password = 'password'; // あなたのデータベースパスワードを設定してください
39
40    try {
41        // PDOインスタンスの作成
42        // オプション:
43        //   - PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION: エラー発生時にPDOExceptionをスローする設定
44        //   - PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC: デフォルトのフェッチモードを連想配列に設定
45        //   - PDO::MYSQL_ATTR_MULTI_STATEMENTS => true: MySQLドライバに対し、単一のクエリ文字列で
46        //     セミコロン区切りの複数のSQLステートメントを実行することを許可する設定
47        $pdo = new PDO($dsn, $user, $password, [
48            PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION,
49            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
50            PDO::MYSQL_ATTR_MULTI_STATEMENTS => true,
51        ]);
52
53        echo "データベース接続に成功しました。\n";
54
55        // 複数のSELECT文を含むSQLクエリの定義
56        // 最初のSELECT文は `users` テーブルから、2番目のSELECT文は `products` テーブルからデータを取得します。
57        $sql = "SELECT id, name FROM users; SELECT id, name, price FROM products;";
58
59        // クエリを実行し、PDOStatementオブジェクトを取得
60        // この時点で、最初の結果セット (`users` テーブルからのデータ) がアクティブになっています。
61        $stmt = $pdo->query($sql);
62
63        $resultSetCount = 0; // 処理中の結果セットのカウンター
64
65        // nextRowset() メソッドは、次の結果セットが存在し、それがアクティブになった場合に true を返します。
66        // 結果セットが存在しない場合は false を返します。
67        do {
68            $resultSetCount++;
69            echo "\n--- 結果セット #" . $resultSetCount . " ---\n";
70
71            $hasRows = false;
72            // 現在アクティブな結果セットからすべての行を取得し、表示
73            while ($row = $stmt->fetch()) {
74                if (!$hasRows) {
75                    // 最初の行でのみカラム名を表示 (初心者向けに分かりやすく)
76                    echo "カラム: " . implode(", ", array_keys($row)) . "\n";
77                    $hasRows = true;
78                }
79                echo "データ: " . implode(", ", $row) . "\n";
80            }
81
82            if (!$hasRows) {
83                echo "この結果セットには行がありません。\n";
84            }
85
86        } while ($stmt->nextRowset()); // 次の結果セットに移動を試みる
87
88        echo "\nすべての結果セットの処理が完了しました。\n";
89
90    } catch (PDOException $e) {
91        // データベース接続またはクエリ実行に関するエラーを捕捉
92        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
93        // デバッグ情報としてエラーコードも表示
94        echo "エラーコード: " . $e->getCode() . "\n";
95        exit(1); // スクリプトを終了
96    } catch (Exception $e) {
97        // その他の予期せぬエラーを捕捉
98        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
99        exit(1); // スクリプトを終了
100    }
101}
102
103// 関数を実行
104demonstratePdoNextRowset();

PHP 8で利用可能なPDOStatement::nextRowset()メソッドは、データベースから複数の結果セットが返された際に、それらを順に処理するために使用されます。これは特に、PDOのPDO::MYSQL_ATTR_MULTI_STATEMENTSオプションを有効にして、複数のSELECT文を単一のクエリとして実行した場合に、各結果セット間を移動するために非常に重要です。

このメソッドは引数をとりません。呼び出すと、現在アクティブな結果セットを終了し、次に利用可能な結果セットがあればそれをアクティブにします。次の結果セットが存在し、正常に切り替えられた場合はtrueを返し、それ以上結果セットがない場合はfalseを返します。この戻り値を利用することで、ループ内で全ての多重結果セットを順次処理することが可能になります。

サンプルコードでは、usersテーブルとproductsテーブルからデータを取得する2つのSELECT文を同時に実行しています。最初のSELECT文の結果が処理された後、nextRowset()が呼ばれることで2番目のSELECT文の結果セットに切り替わり、そのデータも表示されます。PDOStatement::nextRowset()を使うことで、一度のデータベースアクセスで複数の異なるクエリ結果を効率的に取得し、処理する場面で活躍します。