【PHP8.x】TRANSACTION定数の使い方

Copy
1<?php
2
3/**
4 * SQLite3データベースのトランザクションとbusyTimeoutのサンプルコード。
5 * SQLite3::TRANSACTION定数の使用例を組み込みます。
6 *
7 * システムエンジニアを目指す初心者が、データベース操作におけるトランザクションの重要性と、
8 * リファレンスに記載された定数の利用方法を理解できるように設計されています。
9 */
10function runSqlite3TransactionExample(): void
11{
12    // データベースファイル名。存在しない場合は新規作成されます。
13    $dbFile = 'my_app_database.db';
14
15    // データベース接続オブジェクトを初期化
16    $db = new SQLite3($dbFile);
17
18    // busyTimeoutを設定します。
19    // リファレンス情報に基づき、SQLite3::TRANSACTION定数を第二引数として使用します。
20    // この設定は、データベースがロックされている場合に、指定された時間（ミリ秒）だけ待機するようSQLiteに指示します。
21    // SQLite3::TRANSACTIONは、リファレンスによるとこの 'mode' 引数として使用される定数です。
22    $db->busyTimeout(1000, SQLite3::TRANSACTION); // 1000ミリ秒 (1秒)
23
24    // テーブルが存在しない場合にのみ作成します。
25    $db->exec('CREATE TABLE IF NOT EXISTS products (
26        id INTEGER PRIMARY KEY AUTOINCREMENT,
27        name TEXT NOT NULL,
28        price REAL NOT NULL
29    )');
30
31    try {
32        // トランザクションを開始します。
33        // 複数のデータベース操作を一つの論理的な単位として扱い、
34        // 全ての操作が成功するか、全てが失敗して元に戻るか、のどちらかを保証します。
35        $db->exec('BEGIN');
36
37        // データの挿入操作
38        $db->exec("INSERT INTO products (name, price) VALUES ('Laptop', 1200.00)");
39        $db->exec("INSERT INTO products (name, price) VALUES ('Mouse', 25.50)");
40        $db->exec("INSERT INTO products (name, price) VALUES ('Keyboard', 75.00)");
41
42        // ここでエラーが発生した場合、COMMITは実行されずROLLBACKされます。
43        // 例えば、存在しないテーブルへの挿入などを試みるとエラーになります。
44        // $db->exec("INSERT INTO non_existent_table (column) VALUES ('value')");
45
46        // 全ての操作が成功した場合、変更を確定（コミット）します。
47        $db->exec('COMMIT');
48        echo "トランザクションが正常にコミットされました。\n";
49
50    } catch (Exception $e) {
51        // 例外が発生した場合、変更を破棄（ロールバック）します。
52        // これにより、データベースはトランザクション開始前の状態に戻り、データの整合性が保たれます。
53        $db->exec('ROLLBACK');
54        echo "トランザクションがロールバックされました: " . $e->getMessage() . "\n";
55    } finally {
56        // データベース接続を閉じます。
57        $db->close();
58        echo "データベース接続が閉じられました。\n";
59    }
60
61    // トランザクションの結果を確認するために、データベースの内容を再度読み込みます。
62    echo "\n現在の 'products' テーブルの内容:\n";
63    $db_check = new SQLite3($dbFile);
64    $result = $db_check->query('SELECT * FROM products');
65    while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
66        print_r($row);
67    }
68    $db_check->close();
69
70    // スクリプト実行後にデータベースファイルを削除したい場合は、以下のコメントを解除してください。
71    // if (file_exists($dbFile)) {
72    //     unlink($dbFile);
73    //     echo "\nデータベースファイル '" . $dbFile . "' が削除されました。\n";
74    // }
75}
76
77// サンプル関数を実行します。
78runSqlite3TransactionExample();
79
80?>

このサンプルコードは、PHP 8でSQLite3データベースを操作する際のトランザクション処理と、SQLite3::TRANSACTION定数の具体的な使用方法を、システムエンジニアを目指す初心者向けに解説しています。トランザクションとは、複数のデータベース操作を一つのまとまりとして扱い、全ての操作が成功した場合のみ変更を確定（コミット）し、途中でエラーが発生した場合は全ての変更を取り消して元に戻す（ロールバック）ことで、データの整合性を保証する非常に重要な仕組みです。

コードではまず、SQLite3データベースに接続した後、$db->busyTimeout(1000, SQLite3::TRANSACTION);という行で、データベースがロックされてビジー状態の場合に1000ミリ秒（1秒）待機するように設定しています。ここで利用されているSQLite3::TRANSACTIONは、SQLite3クラスに定義された定数で、内部的に整数値を持ちます。この定数自体に引数はありませんが、busyTimeoutメソッドの第二引数に渡すことで、データベースがビジー状態の際の待機モードを指定するために利用され、安定したデータベースアクセスを可能にします。

その後、try-catchブロック内で$db->exec('BEGIN');によりトランザクションを開始し、複数の製品データを挿入します。全ての挿入が成功すれば$db->exec('COMMIT');で変更を確定し、もし途中でエラーが発生した場合はcatchブロックで$db->exec('ROLLBACK');が実行され、データベースはトランザクション開始前の状態に戻ります。これによりデータの不整合が防がれます。最後にfinallyブロックでデータベース接続を閉じ、データの内容を確認しています。

Copy
1<?php
2
3/**
4 * SQLiteデータベースで安全なトランザクション処理を実行する関数。
5 *
6 * この関数は、提供されたリファレンス情報に基づいてSQLite3::TRANSACTION定数を使用し、
7 * トランザクション処理をtry-catchブロックで安全に管理する方法を示します。
8 *
9 * @param string $dbPath データベースファイルのパス
10 * @return void
11 */
12function performSafeTransaction(string $dbPath): void
13{
14    $db = null;
15    try {
16        // SQLiteデータベースに接続
17        $db = new SQLite3($dbPath);
18        // 例外を有効にすることで、SQLエラーをThrowableとして捕捉できるようにする
19        $db->enableExceptions(true);
20
21        // リファレンス情報に基づき、SQLite3::TRANSACTION 定数の値を取得 (int型と仮定)
22        // この定数は何らかのトランザクションモードや設定値を示すと想定されます。
23        $transactionMode = SQLite3::TRANSACTION;
24
25        // トランザクションを開始するSQLコマンドを実行
26        $db->exec('BEGIN TRANSACTION');
27
28        // ここにトランザクション内で実行するデータベース操作を記述します
29        // 例: テーブル作成、データ挿入、更新など
30        $db->exec('CREATE TABLE IF NOT EXISTS products (id INTEGER PRIMARY KEY, name TEXT, price REAL)');
31        $db->exec("INSERT INTO products (name, price) VALUES ('Laptop', 1200.00)");
32        $db->exec("INSERT INTO products (name, price) VALUES ('Mouse', 25.50)");
33
34        // 意図的にエラーを発生させることで、ロールバックの動作を確認できます
35        // $db->exec("INSERT INTO non_existent_table (column) VALUES (1)");
36
37        // すべてのデータベース操作が成功した場合、トランザクションをコミット
38        $db->exec('COMMIT');
39
40    } catch (Throwable $e) {
41        // エラーが発生した場合、トランザクションをロールバック
42        // データベース接続が存在する場合のみロールバックを試みる
43        if ($db) {
44            // SQLite3クラスには直接commit()やrollback()メソッドがないため、exec()を使用します
45            $db->exec('ROLLBACK');
46        }
47        // エラーは捕捉されますが、出力条件によりエラーメッセージは出力しません。
48        // 実際のアプリケーションでは error_log() などでログに記録することが推奨されます。
49
50    } finally {
51        // データベース接続を必ず閉じる
52        if ($db) {
53            $db->close();
54        }
55    }
56}
57
58// サンプルデータベースファイルのパス
59$dbFilePath = __DIR__ . '/my_database.db';
60
61// トランザクション処理を実行
62performSafeTransaction($dbFilePath);

このコードは、PHPでSQLiteデータベースのトランザクションを安全に実行する方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明します。performSafeTransaction関数は、データベース操作を一連のまとまりとして扱い、エラー発生時に適切に対応するトランザクション処理を示しています。

SQLite3::TRANSACTIONは、PHP 8のSQLite3拡張機能に定義された、トランザクションに関連する設定値を示す整数（int）型の定数です。この定数自体が直接トランザクションを開始するものではありませんが、トランザクションモードの指定などに利用できる可能性があります。

関数内ではtry-catchブロックを使用し、データベースへの接続からSQL操作、そして接続のクローズまでを管理します。tryブロックでBEGIN TRANSACTIONによりトランザクションを開始し、テーブル作成やデータ挿入といった複数のデータベース操作を実行します。これらの操作がすべて成功した場合、COMMITで変更を確定します。

もし途中で何らかのエラーが発生した場合は、catchブロックがそのエラーを捕捉し、ROLLBACKを実行してトランザクション開始前の状態に戻します。これにより、データの一貫性が保証されます。最後に、finallyブロックでは、エラーの有無にかかわらずデータベース接続をclose()メソッドで確実に閉じます。

performSafeTransaction関数は、データベースファイルのパス（$dbPath）を文字列型（string）の引数として受け取ります。戻り値はvoidであり、関数は処理の成功や失敗を直接返すのではなく、内部でデータベース操作を完了させます。