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

Copy
1<?php
2
3/**
4 * PDO::beginTransaction メソッドを使用して、複数のデータベース操作をアトミックに実行するサンプルです。
5 *
6 * beginTransaction はトランザクションを開始し、それに続くSQL操作が全て成功した場合にのみ
7 * データベースに変更が永続化されることを保証します（commit()）。
8 * 途中でエラーが発生した場合は、トランザクション開始前の状態にデータベースを戻します（rollBack()）。
9 *
10 * キーワード「ロック」について：
11 * トランザクションが進行している間、DBMS（データベース管理システム）は内部的にロックメカニズムを使用し、
12 * トランザクションの分離レベルに基づいて、他のユーザーやプロセスから変更中のデータへのアクセスを制御します。
13 * これにより、データの不整合を防ぎ、一貫性を保ちます。
14 */
15function transferFundsWithTransaction(): void
16{
17    // SQLiteのインメモリデータベースを使用。これにより、ファイルシステムへの依存なく
18    // このサンプルコードを単体で実行・テストできます。
19    $dsn = 'sqlite::memory:';
20    $pdo = null; // PDOオブジェクトを初期化
21
22    try {
23        $pdo = new PDO($dsn);
24        // エラー発生時に例外をスローするように設定
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        // テーブルが存在しない場合に作成
32        $pdo->exec("
33            CREATE TABLE IF NOT EXISTS accounts (
34                id INTEGER PRIMARY KEY AUTOINCREMENT,
35                name TEXT NOT NULL,
36                balance INTEGER NOT NULL
37            );
38        ");
39        echo "accounts テーブルを作成しました。\n";
40
41        // 初期データを挿入
42        $pdo->exec("INSERT INTO accounts (name, balance) VALUES ('Alice', 1000);");
43        $pdo->exec("INSERT INTO accounts (name, balance) VALUES ('Bob', 500);");
44        echo "初期データ（Alice: 1000, Bob: 500）を挿入しました。\n\n";
45
46        echo "--- トランザクションを開始します ---\n";
47        // トランザクションを開始。これ以降のデータベース操作は、commit()されるまで一時的な状態です。
48        $pdo->beginTransaction();
49
50        // AliceからBobへ200を移動する操作をシミュレート
51        echo "Aliceから200を減らします...\n";
52        $stmtAlice = $pdo->prepare("UPDATE accounts SET balance = balance - 200 WHERE name = 'Alice'");
53        $stmtAlice->execute();
54
55        // ここで意図的にエラーを発生させることで、ロールバックの挙動をテストできます。
56        // 下のコメントアウトを外して実行してみてください。
57        // throw new Exception("送金処理中に予期せぬエラーが発生しました！");
58
59        echo "Bobに200を追加します...\n";
60        $stmtBob = $pdo->prepare("UPDATE accounts SET balance = balance + 200 WHERE name = 'Bob'");
61        $stmtBob->execute();
62
63        // 全ての操作が成功した場合、トランザクションを確定（コミット）します。
64        // これにより、上記の変更がデータベースに永続的に保存されます。
65        $pdo->commit();
66        echo "--- トランザクションが正常にコミットされました ---\n\n";
67
68    } catch (PDOException $e) {
69        // PDO関連のエラーが発生した場合
70        // トランザクションがアクティブであればロールバックする
71        if ($pdo && $pdo->inTransaction()) {
72            $pdo->rollBack();
73            echo "--- データベースエラーによりトランザクションがロールバックされました ---\n";
74        }
75        echo "エラー: データベース操作中に問題が発生しました: " . $e->getMessage() . "\n";
76    } catch (Exception $e) {
77        // その他のPHPエラーが発生した場合
78        // トランザクションがアクティブであればロールバックする
79        if ($pdo && $pdo->inTransaction()) {
80            $pdo->rollBack();
81            echo "--- 一般エラーによりトランザクションがロールバックされました ---\n";
82        }
83        echo "エラー: 予期せぬ問題が発生しました: " . $e->getMessage() . "\n";
84    } finally {
85        // トランザクション後のアカウント残高を表示して結果を確認
86        if ($pdo) {
87            echo "--- 現在のアカウント残高 ---\n";
88            $stmt = $pdo->query("SELECT name, balance FROM accounts");
89            foreach ($stmt as $row) {
90                echo "{$row['name']}: {$row['balance']}\n";
91            }
92        }
93    }
94}
95
96// サンプル関数の実行
97transferFundsWithTransaction();
98
99?>

PHPのPDO::beginTransactionは、データベースに対する複数の操作を「アトミック」、つまり全て成功するか、全て失敗して元に戻すか、のどちらか一方になるようにまとめるために使われるメソッドです。このメソッドは引数を取らず、トランザクションの開始に成功すればtrueを、失敗すればfalseを返します。

提示されたサンプルコードでは、AliceからBobへ資金を送金する処理を例に、このアトミックな操作の重要性を示しています。まずbeginTransaction()でトランザクションを開始し、Aliceの残高を減らす操作と、Bobの残高を増やす操作を実行します。もし、いずれかの操作が途中で失敗した場合でも、rollBack()メソッドによってトランザクション開始前の状態にデータベースを戻すことができます。全ての操作が問題なく完了した場合には、commit()メソッドによってこれらの変更がデータベースに永続的に保存され、データの不整合が起こるのを防ぎます。

トランザクションが進行している間、データベース管理システム（DBMS）は、データの整合性を保つため、内部的に「ロック」の仕組みを利用します。これにより、同じデータを複数のユーザーやプロセスが同時に変更しようとした際に競合が起きないよう制御され、送金のような一連の操作が安全かつ正確に行われることが保証されます。

Copy
1<?php
2
3/**
4 * PDO::beginTransaction メソッドの使用例を示す関数。
5 *
6 * この関数は、トランザクション内で複数のデータベース操作（INSERTなど）を実行し、
7 * すべての操作が成功した場合はトランザクションをコミット（永続化）、
8 * いずれかの操作でエラーが発生した場合はトランザクションをロールバック（取り消し）します。
9 *
10 * 実行には、以下の点を環境に合わせて変更してください。
11 * 1. `$dsn`, `$user`, `$password` を実際のデータベース接続情報に置き換えてください。
12 * 2. `testdb` データベースに `users` テーブルが事前に存在している必要があります。
13 *    (例: `CREATE TABLE users (id INT AUTO_INCREMENT PRIMARY KEY, name VARCHAR(255), email VARCHAR(255) UNIQUE);`)
14 */
15function examplePdoBeginTransaction(): void
16{
17    // データベース接続情報 (ご自身の環境に合わせて変更してください)
18    $dsn = 'mysql:host=localhost;dbname=testdb;charset=utf8mb4'; // MySQLの例
19    $user = 'your_username';   // データベースのユーザー名
20    $password = 'your_password'; // データベースのパスワード
21
22    // PDO接続オプション
23    $options = [
24        PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION, // エラー発生時にPDOExceptionをスローする
25        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,       // デフォルトのフェッチモードを連想配列にする
26        PDO::ATTR_EMULATE_PREPARES   => false,                  // プリペアドステートメントのエミュレーションを無効にする (推奨)
27    ];
28
29    $pdo = null; // PDOオブジェクトを初期化
30
31    try {
32        // データベースに接続
33        $pdo = new PDO($dsn, $user, $password, $options);
34        echo "データベースに接続しました。\n";
35
36        // トランザクションを開始
37        // ここからコミットまたはロールバックされるまでのデータベース変更は一時的なものとなる
38        $pdo->beginTransaction();
39        echo "トランザクションを開始しました。\n";
40
41        // トランザクション内で複数のデータベース操作を実行
42        // usersテーブルが存在することを前提とします。
43        $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
44
45        // 1つ目のユーザーを挿入
46        $stmt->execute(['Alice', 'alice@example.com']);
47        echo "ユーザー 'Alice' を挿入しました。\n";
48
49        // 2つ目のユーザーを挿入
50        // 仮に、この操作でエラーが発生した場合（例: emailカラムのUNIQUE制約違反）、
51        // catchブロックで捕捉され、トランザクションはロールバックされる
52        $stmt->execute(['Bob', 'bob@example.com']);
53        echo "ユーザー 'Bob' を挿入しました。\n";
54
55        // すべての操作が成功した場合、トランザクションをコミット
56        // これにより、beginTransaction()以降のすべての変更がデータベースに永続的に保存される
57        $pdo->commit();
58        echo "トランザクションをコミットしました。\n";
59
60    } catch (PDOException $e) {
61        // データベース操作中にエラーが発生した場合
62        echo "エラーが発生しました: " . $e->getMessage() . "\n";
63
64        // トランザクションが開始されており、まだコミットされていない場合のみロールバック
65        if ($pdo && $pdo->inTransaction()) {
66            // トランザクションをロールバック
67            // これにより、beginTransaction()以降のすべての変更が取り消される
68            $pdo->rollBack();
69            echo "トランザクションをロールバックしました。\n";
70        }
71    }
72}
73
74// サンプル関数を実行
75examplePdoBeginTransaction();

PDO::beginTransactionメソッドは、PHPでデータベース操作を行う際に、トランザクションを開始するために使用します。トランザクションとは、複数のデータベース操作（データの挿入、更新、削除など）をひとまとまりの処理として扱い、その全てが成功した場合にだけデータベースに変更を適用（コミット）し、途中で何らかのエラーが発生した場合には、それまでの操作を全て取り消す（ロールバック）仕組みです。このメソッドは引数を取りません。戻り値は真偽値（bool）で、トランザクションの開始に成功した場合はtrueを、失敗した場合はfalseを返します。

サンプルコードでは、データベースに接続した後、$pdo->beginTransaction()を呼び出すことでトランザクションを開始しています。これにより、以降のデータベース操作は一時的な状態となります。複数のユーザーデータを挿入する処理が実行され、これらの操作が全て成功すれば、$pdo->commit()によってトランザクション内の変更がデータベースに永続的に保存されます。しかし、もし途中の操作でエラーが発生した場合（例えば、ユニーク制約違反など）、catchブロックでエラーを捕捉し、$pdo->rollBack()を呼び出してトランザクションをキャンセルします。これにより、beginTransactionが呼び出されて以降に行われた全ての変更がデータベースから取り消され、データベースの状態は操作開始前の状態に戻ります。このように、beginTransactionは、複数の関連するデータベース操作においてデータの整合性を保証するために非常に重要な役割を果たします。