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

Copy
1<?php
2
3/**
4 * データベーストランザクションの例を実行します。
5 * SQLiteのインメモリデータベースを使用し、begin / commit / rollbackの基本的な流れと、
6 * それがどのようにデータの整合性を保証するかを示します。
7 */
8function performDatabaseTransactionExample(): void
9{
10    // インメモリデータベースを使用することで、一時的にデータベースを操作し、
11    // ファイルシステムに何も残さずにスクリプトを終了できます。
12    $dbPath = ':memory:';
13
14    try {
15        // 1. データベースへの接続
16        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定することで、
17        // SQLエラーが発生した場合に例外がスローされ、適切にエラー処理を行えるようになります。
18        $pdo = new PDO("sqlite:$dbPath", null, null, [
19            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
20            // SELECT文の結果を連想配列で取得するようデフォルト設定
21            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
22        ]);
23
24        echo "データベースに接続しました。\n";
25
26        // 2. サンプルテーブルの作成
27        // accounts テーブルを作成します。既に存在する場合は何もしません (IF NOT EXISTS)。
28        $pdo->exec("
29            CREATE TABLE IF NOT EXISTS accounts (
30                id INTEGER PRIMARY KEY,
31                name TEXT NOT NULL,
32                balance REAL NOT NULL
33            );
34        ");
35        echo "テーブル 'accounts' を作成または確認しました。\n";
36
37        // 初期データの挿入
38        // 例: AliceとBobの初期残高を設定します。
39        $pdo->exec("INSERT OR IGNORE INTO accounts (id, name, balance) VALUES (1, 'Alice', 100.0);");
40        $pdo->exec("INSERT OR IGNORE INTO accounts (id, name, balance) VALUES (2, 'Bob', 50.0);");
41        echo "初期データを挿入または確認しました。\n";
42
43        echo "\n--- トランザクション前の残高 ---\n";
44        displayAccountBalances($pdo);
45
46        // 3. トランザクションの開始
47        // beginTransaction() は、これ以降の一連のデータベース操作を
48        // 一つの論理的な単位として扱います。
49        // この操作が成功すると、データベースは一時的にロック状態になり、
50        // 他のプロセスからのデータ変更（書き込み）をブロックしたり、
51        // 一貫性のあるデータビューを提供したりすることで、データの整合性を保証します。
52        // (SQLiteではファイルレベルのロックが使用されます)
53        $pdo->beginTransaction();
54        echo "\nトランザクションを開始しました。\n";
55
56        // 4. 複数のSQL操作 (例: AliceからBobへ20円送金するシナリオ)
57        $transferAmount = 20.0;
58        $aliceId = 1;
59        $bobId = 2;
60
61        // Aliceの残高を減らす
62        $stmt = $pdo->prepare("UPDATE accounts SET balance = balance - :amount WHERE id = :id;");
63        $stmt->execute([':amount' => $transferAmount, ':id' => $aliceId]);
64        echo "Aliceの残高から $transferAmount を減らしました。\n";
65
66        // ここで意図的にエラーを発生させることで、トランザクションがロールバックされる挙動を試せます。
67        // 下の行のコメントアウトを外して実行してみてください。
68        // throw new Exception("意図的なエラー: 送金処理を中断します。");
69
70        // Bobの残高を増やす
71        $stmt = $pdo->prepare("UPDATE accounts SET balance = balance + :amount WHERE id = :id;");
72        $stmt->execute([':amount' => $transferAmount, ':id' => $bobId]);
73        echo "Bobの残高に $transferAmount を増やしました。\n";
74
75        // 5. トランザクションのコミット
76        // すべての操作が成功した場合、commit() を呼び出して、
77        // トランザクション中のすべての変更をデータベースに永続的に保存します。
78        $pdo->commit();
79        echo "\nトランザクションが正常にコミットされました。\n";
80
81    } catch (PDOException $e) {
82        // データベース関連のエラーが発生した場合
83        // トランザクションがアクティブな場合、rollBack() を呼び出して
84        // トランザクション開始時点の状態にデータベースを戻します。
85        // これにより、部分的な変更が残ることを防ぎ、データの整合性を保ちます。
86        if (isset($pdo) && $pdo->inTransaction()) {
87            $pdo->rollBack();
88            echo "\nデータベースエラーが発生したため、トランザクションはロールバックされました。\n";
89        }
90        echo "エラー: データベース操作中に問題が発生しました。 " . $e->getMessage() . "\n";
91    } catch (Exception $e) {
92        // その他のPHPエラーが発生した場合
93        if (isset($pdo) && $pdo->inTransaction()) {
94            $pdo->rollBack();
95            echo "\n予期せぬエラーが発生したため、トランザクションはロールバックされました。\n";
96        }
97        echo "エラー: " . $e->getMessage() . "\n";
98    } finally {
99        // トランザクションが成功したか失敗したかにかかわらず、最終的なアカウント残高を表示します。
100        echo "\n--- トランザクション後の残高 ---\n";
101        if (isset($pdo)) {
102            displayAccountBalances($pdo);
103        }
104        echo "\n--- スクリプト終了 ---\n";
105    }
106}
107
108/**
109 * 現在のアカウント残高をデータベースから取得して表示するヘルパー関数。
110 *
111 * @param PDO $pdo データベース接続オブジェクト
112 */
113function displayAccountBalances(PDO $pdo): void
114{
115    $stmt = $pdo->query("SELECT id, name, balance FROM accounts ORDER BY id;");
116    while ($row = $stmt->fetch()) {
117        echo sprintf("ID: %d, 名前: %s, 残高: %.2f\n", $row['id'], $row['name'], $row['balance']);
118    }
119}
120
121// スクリプトを実行します。
122performDatabaseTransactionExample();

PHPのPDO::beginTransaction()メソッドは、データベースに対する一連の操作を「トランザクション」と呼ばれる一つの論理的な単位として開始するために用いられます。このメソッドを使用することで、複数のSQL文をまとめて実行し、そのすべてが成功した場合にのみ変更をデータベースに永続的に反映（コミット）し、途中で何らかの問題が発生した場合はすべての変更を元の状態に戻す（ロールバック）ことができます。これにより、データの一貫性と整合性が確実に保たれます。

例えば、サンプルコードの送金処理のように、Aliceの口座から残高を減らし、Bobの口座に増やすという二つの更新操作は、どちらか一方だけが完了してはいけません。beginTransaction()を呼び出すと、これらの操作は一時的なものとして扱われ、データベースは他のプロセスからの書き込みを制限する「ロック」状態になることがあります。これは、送金処理中に他のユーザーが関連データを変更してしまい、不整合な状態が発生するのを防ぐためです。

このメソッドに引数はなく、トランザクションの開始に成功した場合はブール値trueを、失敗した場合はfalseを戻り値として返します。beginTransaction()は、複雑なビジネスロジックにおいてデータベースの信頼性を確保するための基盤となる重要な機能です。

Copy
1<?php
2
3/**
4 * PDO::beginTransaction() の使用例
5 *
6 * このスクリプトは、PHP の PDO (PHP Data Objects) を使用して、
7 * データベーストランザクションを扱う方法を示します。
8 * トランザクションは、複数のデータベース操作（例: INSERT, UPDATE）を
9 * 一つの論理的な単位としてまとめ、全ての操作が成功した場合のみ変更を確定し、
10 * 途中でエラーが発生した場合は全ての変更を元に戻す（ロールバックする）ために使用されます。
11 *
12 * ここでは SQLite のインメモリデータベースを使用し、ファイルシステムを汚すことなく
13 * 単体で動作可能な例を提供します。
14 */
15function runPdoBeginTransactionExample(): void
16{
17    // SQLite のインメモリデータベースに接続するための DSN (Data Source Name)
18    // ':memory:' は一時的なメモリ上データベースを作成します。
19    $dsn = 'sqlite::memory:';
20
21    try {
22        // 1. PDO インスタンスを作成し、データベースに接続
23        //    PDO::ERRMODE_EXCEPTION を設定することで、SQL エラーが発生した際に
24        //    PDOException がスローされるようになります。
25        $pdo = new PDO($dsn);
26        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
27
28        echo "データベースに正常に接続しました。\n";
29
30        // 2. テスト用のテーブルを作成
31        //    このテーブルにユーザー情報を挿入します。
32        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
33            id INTEGER PRIMARY KEY AUTOINCREMENT,
34            name TEXT NOT NULL,
35            email TEXT NOT NULL UNIQUE
36        );");
37        echo "テーブル 'users' が作成されました。\n";
38
39        // 3. トランザクションを開始
40        //    beginTransaction() を呼び出すと、これ以降のデータベース操作は
41        //    一時的にバッファリングされ、まだデータベースに永続的に書き込まれません。
42        $pdo->beginTransaction();
43        echo "トランザクションを開始しました。\n";
44
45        // 4. 最初のデータベース操作（ユーザー挿入）
46        $stmt1 = $pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
47        $stmt1->execute(['山田 太郎', 'taro.yamada@example.com']);
48        echo "ユーザー '山田 太郎' を挿入しました。\n";
49
50        // 5. 2番目のデータベース操作（ユーザー挿入）
51        //    もしここでエラーが発生した場合（例: UNIQUE制約違反など）、
52        //    トランザクションはロールバックされ、最初の挿入も取り消されます。
53        $stmt2 = $pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
54        $stmt2->execute(['鈴木 次郎', 'jiro.suzuki@example.com']);
55        echo "ユーザー '鈴木 次郎' を挿入しました。\n";
56
57        // 例外を発生させてロールバックを試すには、以下の行のコメントを解除してください。
58        // $stmt3 = $pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
59        // $stmt3->execute(['重複 メール', 'taro.yamada@example.com']); // email が重複するためエラー
60
61        // 6. 全ての操作が成功した場合、トランザクションをコミット
62        //    commit() を呼び出すと、トランザクション内の全ての変更が
63        //    データベースに永続的に保存されます。
64        $pdo->commit();
65        echo "トランザクションをコミットしました。全ての変更が保存されました。\n";
66
67        // 7. 挿入されたデータを確認
68        echo "\nデータベース内のユーザー一覧:\n";
69        $result = $pdo->query("SELECT id, name, email FROM users");
70        foreach ($result as $row) {
71            echo "ID: {$row['id']}, 名前: {$row['name']}, メール: {$row['email']}\n";
72        }
73
74    } catch (PDOException $e) {
75        // エラーが発生した場合
76        // トランザクションがアクティブであれば、rollBack() を呼び出して
77        // トランザクション開始以降の全ての変更を取り消します。
78        if ($pdo->inTransaction()) {
79            $pdo->rollBack();
80            echo "エラーが発生したため、トランザクションをロールバックしました。変更は破棄されました。\n";
81        }
82        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
83    } catch (Exception $e) {
84        // その他の予期せぬエラー
85        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
86    } finally {
87        // データベース接続をクローズ（PDO オブジェクトを null に設定）
88        $pdo = null;
89        echo "データベース接続を閉じました。\n";
90    }
91}
92
93// サンプルコードを実行
94runPdoBeginTransactionExample();
95

PDO::beginTransaction() は、PHPのPDO (PHP Data Objects) を利用してデータベース操作を行う際に、トランザクションを開始するためのメソッドです。トランザクションとは、複数のデータベース操作（例：データの挿入、更新、削除など）を一つにまとめ、それら全ての操作が成功した場合のみデータベースへの変更を確定し（コミット）、途中でエラーが発生した場合は全ての変更を元に戻す（ロールバック）仕組みのことです。これにより、データベースのデータが常に整合性の取れた状態に保たれ、部分的な変更が適用されることを防ぎます。

このメソッドを呼び出すと、これ以降のデータベースへの変更は一時的に保持され、まだ永続的に書き込まれません。一連の処理が全て正常に完了した場合は別途 PDO::commit() を呼び出して変更を確定させ、もし途中でエラーが発生した場合は PDO::rollBack() を呼び出してトランザクション開始時点の状態に戻します。

beginTransaction() メソッドは引数を取らずに呼び出され、戻り値として bool 型の値を返します。通常、トランザクションが正常に開始できた場合は true を返しますが、開始に失敗した場合は PDOException がスローされることが一般的なため、戻り値の確認よりも例外処理を用いてエラーハンドリングを行うことが推奨されます。提供されたサンプルコードでは、SQLiteのインメモリデータベース上で複数のユーザー挿入処理をトランザクション内で実行し、データの一貫性を確保する具体的な流れが示されています。