【PHP8.x】SQLite3::CREATE_TRIGGER定数の使い方

Copy
1<?php
2
3/**
4 * SQLite3::CREATE_TRIGGER 定数の値と、それに関連するSQLiteトリガーの作成方法をデモンストレーションします。
5 * この定数は、ユーザー定義関数がトリガー内で使用される意図があることを示すためのフラグとして用いられます。
6 *
7 * Demonstrates the value of the SQLite3::CREATE_TRIGGER constant and how to create
8 * an SQLite trigger. This constant is used as a flag to indicate that a
9 * user-defined function is intended for use within a trigger.
10 */
11function demonstrateSqliteTriggerConstant(): void
12{
13    // 1. SQLite3 データベースをオープン（メモリ上で一時的に作成）
14    // Opens an SQLite3 database (in-memory for a temporary database).
15    $db = new SQLite3(':memory:');
16
17    if (!$db) {
18        echo "データベースを開けませんでした。\n";
19        return;
20    }
21
22    // SQLite3::CREATE_TRIGGER 定数の値を出力
23    // Outputs the integer value of the SQLite3::CREATE_TRIGGER constant.
24    echo "SQLite3::CREATE_TRIGGER の値: " . SQLite3::CREATE_TRIGGER . "\n\n";
25
26    // 2. サンプルテーブルを作成
27    // Creates a sample table named 'products'.
28    $db->exec('CREATE TABLE IF NOT EXISTS products (
29        id INTEGER PRIMARY KEY AUTOINCREMENT,
30        name TEXT NOT NULL,
31        price REAL NOT NULL
32    )');
33    echo "テーブル 'products' を作成しました。\n";
34
35    // 3. ユーザー定義関数を登録
36    // この関数はトリガー内で呼び出されることを想定しており、
37    // SQLite3::CREATE_TRIGGER フラグは、その関数の使用意図を示すために createFunction() に渡されます。
38    // Registers a user-defined function 'log_change'.
39    // This function is intended to be called within a trigger.
40    // The SQLite3::CREATE_TRIGGER flag is passed to createFunction() to indicate this intent.
41    $db->createFunction(
42        'log_change', // SQLで使用する関数名
43        function (int $product_id, float $old_price, float $new_price): bool {
44            // ここで、商品の価格変更をログに記録するなどの処理を行うことができます。
45            // In a real application, you would typically log this to a file or a dedicated log table.
46            echo sprintf(
47                "トリガー発動: Product ID %d の価格が %.2f から %.2f に変更されました。\n",
48                $product_id,
49                $old_price,
50                $new_price
51            );
52            return true; // 処理が成功したことを示す
53        },
54        3, // 関数の引数の数
55        SQLite3::CREATE_TRIGGER // この関数がトリガー内で使用されることを示すフラグ
56    );
57    echo "ユーザー定義関数 'log_change' を登録しました。\n";
58
59    // 4. トリガーを作成
60    // トリガーはSQL文を使って作成され、SQLite3::exec() メソッドで実行します。
61    // 'product_price_update' トリガーは、'products' テーブルの 'price' カラムが更新された後に発動し、
62    // 登録したユーザー定義関数 'log_change' を呼び出します。
63    // Creates a trigger using a standard SQL statement executed via SQLite3::exec().
64    // The 'product_price_update' trigger fires AFTER an update to the 'price' column
65    // in the 'products' table, calling the user-defined 'log_change' function.
66    $db->exec('
67        CREATE TRIGGER IF NOT EXISTS product_price_update
68        AFTER UPDATE OF price ON products
69        FOR EACH ROW
70        WHEN NEW.price <> OLD.price
71        BEGIN
72            SELECT log_change(OLD.id, OLD.price, NEW.price);
73        END;
74    ');
75    echo "トリガー 'product_price_update' を作成しました。\n\n";
76
77    // 5. データ挿入と更新でトリガーをテスト
78    // Insert initial data into the 'products' table.
79    $db->exec("INSERT INTO products (name, price) VALUES ('Laptop', 1200.00)");
80    echo "製品 'Laptop' を挿入しました。\n";
81    $db->exec("INSERT INTO products (name, price) VALUES ('Mouse', 25.00)");
82    echo "製品 'Mouse' を挿入しました。\n";
83    $db->exec("INSERT INTO products (name, price) VALUES ('Keyboard', 75.00)");
84    echo "製品 'Keyboard' を挿入しました。\n\n";
85
86    // データの更新を行い、トリガーを意図的に発動させます。
87    // Updates product prices to fire the trigger.
88    echo "製品の価格を更新します...\n";
89    $db->exec("UPDATE products SET price = 1250.00 WHERE name = 'Laptop'"); // 価格変更あり -> トリガー発動
90    $db->exec("UPDATE products SET price = 30.00 WHERE name = 'Mouse'");    // 価格変更あり -> トリガー発動
91    $db->exec("UPDATE products SET price = 75.00 WHERE name = 'Keyboard'"); // 価格変更なし (WHEN条件で除外) -> トリガーは発動しない
92    echo "\n製品の価格更新が完了しました。\n";
93
94    // データベース接続をクローズ
95    // Closes the database connection.
96    $db->close();
97}
98
99// 関数を実行してデモンストレーションを開始
100// Executes the function to start the demonstration.
101demonstrateSqliteTriggerConstant();

SQLite3::CREATE_TRIGGERは、PHPでSQLiteデータベースを扱う際に、登録するユーザー定義関数がデータベースのトリガー内で使用されることを示すための定数です。この定数の値は整数型であり、SQLite3::createFunction()メソッドの引数として渡すことで、関数の利用意図を明確にします。

サンプルコードでは、まず一時的なSQLiteデータベースを開き、この定数の具体的な値を出力しています。次に、productsというサンプルテーブルを作成した後、商品の価格変更を記録するlog_changeというユーザー定義関数を登録します。この際、SQLite3::CREATE_TRIGGERをフラグとして渡すことで、log_change関数がトリガー内で呼び出されることを示しています。その後、product_price_updateというトリガーを定義し、productsテーブルのpriceカラムが更新された場合に、登録したlog_change関数が古い価格と新しい価格を引数として自動的に実行されるように設定しています。最後に、データを挿入し、価格を更新することで、実際にトリガーが発動し、ユーザー定義関数による出力が行われる一連の流れを確認することができます。これにより、データベースのイベントに応じてカスタム処理を自動実行する方法を理解できます。

Copy
1<?php
2
3/**
4 * PHPでMySQLデータベースにトリガーを作成するサンプル関数です。
5 * システムエンジニアを目指す初心者向けに、データベーストリガーの
6 * 基本的な作成と動作確認の方法を示します。
7 *
8 * このコードは、`products` テーブルの在庫 (stock) が更新された際に、
9 * `product_log` テーブルにその変更を記録するトリガーを作成します。
10 *
11 * 事前準備:
12 * - MySQLサーバーが稼働していること
13 * - 適切なデータベース (`test_db` など) が存在すること
14 * - データベースに接続するためのユーザー名とパスワードが設定されていること
15 *   (例: ユーザー名 `root`, パスワード `password`)
16 * - PDO拡張が有効になっていること (php.iniで `extension=pdo_mysql` を有効化)
17 *
18 * 注意: このコードは学習・テスト目的であり、実際の運用環境では
19 * データベース接続情報などを環境変数や設定ファイルで管理し、
20 * より堅牢なエラーハンドリングを実装してください。
21 */
22function createMySqlTriggerExample(): void
23{
24    // データベース接続設定
25    $host = 'localhost';
26    $dbName = 'test_db'; // 適切なデータベース名に変更してください
27    $user = 'root';      // 適切なユーザー名に変更してください
28    $password = 'password'; // 適切なパスワードに変更してください
29    $charset = 'utf8mb4';
30
31    // DSN (Data Source Name) の構築
32    $dsn = "mysql:host=$host;dbname=$dbName;charset=$charset";
33    $options = [
34        PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION, // エラー発生時に例外をスロー
35        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,       // 結果を連想配列で取得
36        PDO::ATTR_EMULATE_PREPARES   => false,                  // プリペアドステートメントのエミュレーションを無効に
37    ];
38
39    try {
40        // データベースに接続
41        $pdo = new PDO($dsn, $user, $password, $options);
42        echo "データベースに接続しました。\n";
43
44        // === トリガーの対象となるテーブルの準備 ===
45
46        // 1. products テーブル (在庫情報を管理)
47        $pdo->exec("
48            CREATE TABLE IF NOT EXISTS products (
49                id INT AUTO_INCREMENT PRIMARY KEY,
50                name VARCHAR(255) NOT NULL,
51                stock INT NOT NULL DEFAULT 0,
52                last_updated TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
53            );
54        ");
55        echo "テーブル 'products' を確認または作成しました。\n";
56
57        // 2. product_log テーブル (トリガーによるログを記録)
58        $pdo->exec("
59            CREATE TABLE IF NOT EXISTS product_log (
60                log_id INT AUTO_INCREMENT PRIMARY KEY,
61                product_id INT NOT NULL,
62                action VARCHAR(50) NOT NULL,
63                old_stock INT,
64                new_stock INT,
65                log_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP
66            );
67        ");
68        echo "テーブル 'product_log' を確認または作成しました。\n";
69
70        // === トリガーの作成 ===
71
72        // 既存のトリガーを削除 (もしあれば、再作成のために)
73        $pdo->exec("DROP TRIGGER IF EXISTS after_product_update;");
74        echo "既存のトリガー 'after_product_update' を削除しました (もしあれば)。\n";
75
76        // 新しいトリガーを作成するSQL文
77        // products テーブルの 'stock' カラムが更新された後に実行されるトリガーです。
78        // stockの値が変更された場合にのみ、product_log テーブルにログを記録します。
79        $triggerSql = "
80            CREATE TRIGGER after_product_update
81            AFTER UPDATE ON products
82            FOR EACH ROW
83            BEGIN
84                -- OLD は更新前の行データ、NEW は更新後の行データを示します
85                IF OLD.stock <> NEW.stock THEN
86                    INSERT INTO product_log (product_id, action, old_stock, new_stock)
87                    VALUES (NEW.id, 'stock_update', OLD.stock, NEW.stock);
88                END IF;
89            END;
90        ";
91
92        // トリガーを実行して作成
93        $pdo->exec($triggerSql);
94        echo "トリガー 'after_product_update' を正常に作成しました。\n";
95
96        // === トリガーの動作確認 ===
97        echo "\n--- トリガー動作確認 ---\n";
98
99        // テストデータ挿入のためにテーブルをクリア
100        $pdo->exec("TRUNCATE TABLE products;");
101        $pdo->exec("TRUNCATE TABLE product_log;");
102        echo "テーブル 'products' と 'product_log' をクリアしました。\n";
103
104        // 初期データを挿入
105        $pdo->exec("INSERT INTO products (name, stock) VALUES ('Example Product A', 10);");
106        $pdo->exec("INSERT INTO products (name, stock) VALUES ('Example Product B', 20);");
107        echo "初期データを挿入しました。\n";
108
109        // 製品Aの在庫を更新 (stockが変更されるため、トリガーが発動しログが記録される)
110        $pdo->exec("UPDATE products SET stock = 8 WHERE name = 'Example Product A';");
111        echo "製品Aの在庫を更新しました (ログが記録されるはず)。\n";
112
113        // 製品Aの名前を更新 (stockは変更されないため、トリガーは発動せずログは記録されない)
114        $pdo->exec("UPDATE products SET name = 'Example Product A (Revised)' WHERE name = 'Example Product A (Revised)';");
115        echo "製品Aの名前を更新しました (stock変更なしのため、ログは記録されないはず)。\n";
116
117        // 製品Bの在庫を更新 (stockが変更されるため、トリガーが発動しログが記録される)
118        $pdo->exec("UPDATE products SET stock = 25 WHERE name = 'Example Product B';");
119        echo "製品Bの在庫を更新しました (ログが記録されるはず)。\n";
120
121        // product_log テーブルの内容を表示して、トリガーの動作を確認
122        echo "\n--- product_log テーブルの内容 ---\n";
123        $stmt = $pdo->query("SELECT * FROM product_log ORDER BY log_id;");
124        $logs = $stmt->fetchAll();
125
126        if (count($logs) > 0) {
127            foreach ($logs as $log) {
128                echo sprintf(
129                    "Log ID: %s, Product ID: %s, Action: %s, Old Stock: %s, New Stock: %s, Time: %s\n",
130                    $log['log_id'], $log['product_id'], $log['action'], $log['old_stock'], $log['new_stock'], $log['log_time']
131                );
132            }
133        } else {
134            echo "product_log テーブルにログは記録されていません。\n";
135        }
136
137    } catch (PDOException $e) {
138        // データベース接続やSQL実行時のエラーを捕捉
139        echo "エラーが発生しました: " . $e->getMessage() . "\n";
140        // 実際のアプリケーションでは、エラーメッセージをログファイルに記録するなど、
141        // より詳細なエラーハンドリングを行うべきです。
142    } finally {
143        // データベース接続を閉じる (PDOはスクリプト終了時に自動的に閉じられることが多い)
144        $pdo = null;
145        echo "\nデータベース接続を閉じました。\n";
146    }
147}
148
149// サンプル関数を実行
150createMySqlTriggerExample();
151

このPHPサンプルコードは、システムエンジニアを目指す初心者の方に向け、PHPのPDO拡張を利用してMySQLデータベースにトリガーを作成する方法を分かりやすく説明しています。トリガーとは、データベース内で特定のイベント（例えば、データの更新や挿入、削除など）が発生した際に、自動的に実行される処理のことです。

このコードでは、productsという商品在庫管理用のテーブルの在庫数（stockカラム）が更新された場合に、その変更履歴をproduct_logテーブルに自動的に記録するトリガーを作成します。具体的には、CREATE TRIGGER文を使い、productsテーブルのデータが更新された直後（AFTER UPDATE）に、更新前の在庫数（OLD.stock）と更新後の在庫数（NEW.stock）を比較し、在庫数が実際に変更されている場合にのみproduct_logテーブルに記録を行う仕組みです。

PHPからはPDOのexecメソッドを通じてSQLのトリガー作成文を実行するため、PHP側に直接的な引数や戻り値を持つ関数はありません。提供されたリファレンス情報にあるSQLite3::CREATE_TRIGGERは、SQLiteデータベースでトリガーを定義する際に使われる整数値の定数であり、このサンプルコードで扱うMySQLのトリガー作成とは直接関係しません。

コードの最後では、テストデータをproductsテーブルに挿入し、その在庫数を更新することで、作成したトリガーが期待通りに動作し、product_logテーブルにログが適切に記録されることを確認できます。