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

Copy
1<?php
2
3/**
4 * データベースのマイグレーション処理を模倣し、
5 * トランザクションとPDO::rollBack()メソッドの使用例を示します。
6 *
7 * システムエンジニアを目指す初心者向けに、
8 * 複数のデータベース操作を原子的に扱い、エラー発生時に変更を元に戻す（ロールバックする）
9 * トランザクションの重要性を伝えます。
10 *
11 * マイグレーションとは、データベースのスキーマ（テーブル構造）やデータを
12 * 変更・更新する作業のことです。
13 */
14function applyDatabaseMigrationWithTransaction(): void
15{
16    // SQLiteのインメモリデータベースを使用し、手軽に試せるようにします。
17    // スクリプトの実行中のみデータが保持され、終了すると消滅します。
18    $dsn = 'sqlite::memory:';
19    $pdo = null; // PDOオブジェクトを初期化
20
21    try {
22        // 1. データベースへの接続を確立します。
23        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定することで、
24        // データベース操作でエラーが発生した場合にPDOExceptionがスローされるようになります。
25        $pdo = new PDO($dsn);
26        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
27
28        echo "マイグレーション処理を開始します。\n";
29
30        // 2. トランザクションを開始します。
31        // ここからPDO::commit()またはPDO::rollBack()が呼ばれるまで、
32        // 実行される全てのデータベース操作は「一つの単位（原子性）」として扱われます。
33        // 途中でエラーが発生した場合、全ての変更が取り消されます。
34        $pdo->beginTransaction();
35        echo "トランザクションを開始しました。\n";
36
37        // 3. マイグレーション処理のステップ1: 'users' テーブルを作成します。
38        // IF NOT EXISTS を使用することで、テーブルが既に存在してもエラーになりません。
39        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
40            id INTEGER PRIMARY KEY AUTOINCREMENT,
41            name TEXT NOT NULL,
42            email TEXT NOT NULL UNIQUE
43        )");
44        echo "テーブル 'users' を作成しました。\n";
45
46        // 4. マイグレーション処理のステップ2: 初期データを挿入します。
47        $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (:name, :email)");
48        $stmt->execute([':name' => 'Alice', ':email' => 'alice@example.com']);
49        echo "ユーザー 'Alice' を挿入しました。\n";
50
51        // -----------------------------------------------------------
52        // 意図的にエラーを発生させる例：
53        // 以下のコメントアウトを解除すると、UNIQUE制約違反（emailカラムはユニーク）により
54        // PDOExceptionが発生し、トランザクションがロールバックされます。
55        // その結果、直前の 'Alice' の挿入も取り消され、データベースには何も変更が残りません。
56        /*
57        $stmt->execute([':name' => 'Bob', ':email' => 'alice@example.com']);
58        echo "ユーザー 'Bob' を挿入しました。\n"; // この行は実行されません
59        */
60        // -----------------------------------------------------------
61
62        // 5. すべてのデータベース操作が成功した場合、トランザクションをコミットします。
63        // ここで初めて、データベースへの変更が永続的に保存されます。
64        $pdo->commit();
65        echo "すべてのマイグレーション処理が正常に完了し、コミットされました。\n";
66
67    } catch (PDOException $e) {
68        // 6. データベース操作中に例外（エラー）が発生した場合、
69        // トランザクションが開始されていることを確認し、ロールバックします。
70        if ($pdo && $pdo->inTransaction()) {
71            $pdo->rollBack(); // PDO::rollBack() メソッドの呼び出し
72            echo "エラーが発生しました。トランザクションをロールバックしました。\n";
73            echo "ロールバックにより、トランザクション開始後の全ての変更が取り消され、\n";
74            echo "データベースは安全に元の状態に戻されました。\n";
75        }
76        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
77    } finally {
78        // 7. データベース接続を閉じます。
79        // PHPではスクリプト終了時に自動的に閉じられることが多いですが、
80        // 明示的にnullを代入することでリソースを解放する良い習慣です。
81        $pdo = null;
82        echo "データベース接続を閉じました。\n";
83    }
84}
85
86// マイグレーション処理を実行します。
87applyDatabaseMigrationWithTransaction();

このPHPサンプルコードは、データベースのスキーマ変更やデータ更新を行うマイグレーション処理において、トランザクションとPDO::rollBack()メソッドの重要性を示しています。PDO::rollBack()は、PDOクラスに属する引数なしのメソッドで、実行すると操作の成功・失敗を示すbool型の値を返します。

コードではまず、データベースへの接続を確立し、$pdo->beginTransaction()でトランザクションを開始します。これにより、その後の複数のデータベース操作（テーブル作成、データ挿入など）は一連のまとまった処理（原子的な操作）として扱われます。もしこれらの操作の途中でエラーが発生した場合、catchブロックでPDOExceptionが捕捉され、$pdo->rollBack()が呼び出されます。

PDO::rollBack()が実行されると、トランザクション開始以降に行われた全てのデータベース変更が安全に取り消され、データベースはトランザクション開始前の状態に戻ります。例えば、コード中のコメントアウトを解除して意図的にエラーを発生させると、その後のデータ挿入が失敗し、直前の成功したデータ挿入も取り消されることが確認できます。このように、システムエンジニアがデータベースの整合性を保ち、予期せぬエラーからデータを保護するために、PDO::rollBack()は不可欠な機能です。

Copy
1<?php
2
3/**
4 * PDO::rollBack メソッドの使用例を示します。
5 * データベーストランザクションを開始し、エラー発生時に変更をロールバックするシナリオです。
6 *
7 * このスクリプトを実行するには、PHPにPDOドライバ（例: pdo_mysql）がインストールされており、
8 * データベース接続情報（$dsn, $user, $password）を実際の環境に合わせて変更する必要があります。
9 */
10function examplePdoRollBack(): void
11{
12    // データベース接続情報 (実際の環境に合わせて変更してください)
13    // MySQLを例にしていますが、他のデータベースでも同様に動作します。
14    $dsn = 'mysql:host=localhost;dbname=testdb;charset=utf8mb4';
15    $user = 'root'; // 実際のデータベースユーザー名
16    $password = 'password'; // 実際のデータベースパスワード
17
18    $pdo = null; // PDOオブジェクトを初期化
19
20    try {
21        // 1. PDOインスタンスの作成と接続
22        // 接続に失敗した場合はPDOExceptionがスローされます。
23        $pdo = new PDO($dsn, $user, $password);
24        // エラーモードを例外に設定し、SQLエラーが発生した際にPDOExceptionをスローさせます。
25        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
26        // デフォルトのフェッチモードを連想配列に設定します。
27        $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);
28
29        echo "データベースに正常に接続しました。\n";
30
31        // 2. トランザクションを開始
32        // ここからPDO::commit()またはPDO::rollBack()が呼び出されるまで、
33        // データベースへの変更は一時的に保持され、確定されません。
34        $pdo->beginTransaction();
35        echo "トランザクションを開始しました。\n";
36
37        // 3. データベース操作の実行 (例: INSERT, UPDATE, DELETE)
38        // ここに実際のSQLクエリを記述します。
39        // 例:
40        // $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
41        // $stmt->execute(['Alice', 'alice@example.com']);
42        echo "ダミーのデータベース操作を実行中... (ここでは実際には何もしていません)\n";
43
44        // 4. エラーの発生をシミュレート
45        // このフラグを`false`に設定すると、トランザクションはコミットされます。
46        // `true`に設定すると、例外が発生し、トランザクションはロールバックされます。
47        $shouldErrorOccur = true;
48        if ($shouldErrorOccur) {
49            // わざとExceptionをスローし、ロールバックの動作を示します。
50            throw new Exception("意図的にトランザクション中にエラーを発生させました。");
51        }
52
53        // 5. エラーがなければコミット
54        // 全てのデータベース操作が成功した場合、変更を確定します。
55        $pdo->commit();
56        echo "トランザクションが正常にコミットされました。\n";
57
58    } catch (PDOException $e) {
59        // PDO関連のエラーをキャッチ (データベース接続失敗、SQLエラーなど)
60        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
61        // トランザクションが開始されている場合のみロールバックを実行
62        if ($pdo && $pdo->inTransaction()) {
63            // トランザクション中に発生した変更をすべて破棄し、データベースをトランザクション開始前の状態に戻します。
64            $pdo->rollBack();
65            echo "トランザクションがロールバックされました。\n";
66        }
67    } catch (Exception $e) {
68        // その他の一般的なエラーをキャッチ (上記で意図的にスローしたエラーなど)
69        echo "一般的なエラーが発生しました: " . $e->getMessage() . "\n";
70        // トランザクションが開始されている場合のみロールバックを実行
71        if ($pdo && $pdo->inTransaction()) {
72            $pdo->rollBack();
73            echo "トランザクションがロールバックされました。\n";
74        }
75    } finally {
76        // PDOオブジェクトの解放 (スクリプト終了時に自動的に解放されますが、明示的に行う場合もあります)
77        $pdo = null;
78        echo "PDOオブジェクトを解放しました。\n";
79    }
80}
81
82// 関数を実行して、トランザクションの動作を確認します。
83examplePdoRollBack();
84
85?>

PHPのPDO::rollBackメソッドは、データベースのトランザクション処理において、途中でエラーが発生したり、何らかの理由で処理を中断する必要がある場合に、それまでのデータベースへの変更をすべて取り消す役割を担います。これにより、データの整合性を保つことができます。

トランザクションはPDO::beginTransaction()で開始され、複数のデータベース操作（例：データの挿入、更新、削除）が一連の処理として実行されます。すべての操作が成功した場合はPDO::commit()を呼び出して変更を確定しますが、もし途中で問題が発生した場合、PDO::rollBack()を呼び出すことで、beginTransaction()以降に行われたすべての変更が破棄され、データベースはトランザクション開始前の状態に戻されます。

このメソッドは引数を一切取りません。戻り値はbool型で、ロールバック処理が成功した場合はtrue、失敗した場合はfalseを返します。サンプルコードでは、データベース接続後にbeginTransaction()でトランザクションを開始し、意図的にエラーを発生させています。これにより、catchブロック内でPDO::rollBack()が呼び出され、未確定の変更がデータベースに適用されるのを防ぐ様子を示しています。データベースの整合性を保つ上で非常に重要なメソッドです。