【PHP8.x】Pdo\Sqlite::SQLITE_OPEN_READONLY定数の使い方

Copy
1<?php
2
3/**
4 * SQLITE_OPEN_READONLY 定数を使用してSQLiteデータベースを読み取り専用で開く方法を示すサンプルコード。
5 *
6 * この関数は、一時的なSQLiteデータベースを作成し、
7 * その後、SQLITE3::OPEN_READONLY フラグを使ってデータベースを読み取り専用で開く手順を示します。
8 * 読み取り専用モードでは書き込み操作が失敗し、読み取り操作が成功することを確認します。
9 */
10function demonstrateSqliteReadOnlyOpen(): void
11{
12    // データベースファイルのパスを定義
13    $dbFile = __DIR__ . '/temp_readonly_db.sqlite';
14
15    // --- 準備: テスト用データベースを作成し、初期データを投入 ---
16    // (通常、読み取り専用で開くデータベースは既に存在します)
17    try {
18        // 既存のテストファイルを削除（クリーンな状態にするため）
19        if (file_exists($dbFile)) {
20            unlink($dbFile);
21        }
22
23        // データベースを書き込み可能モードで開き、テーブルとデータを準備
24        $dbWritable = new SQLite3($dbFile);
25        $dbWritable->exec('CREATE TABLE IF NOT EXISTS products (id INTEGER PRIMARY KEY, name TEXT, price REAL)');
26        $dbWritable->exec("INSERT INTO products (name, price) VALUES ('Laptop', 1200.00)");
27        $dbWritable->exec("INSERT INTO products (name, price) VALUES ('Mouse', 25.50)");
28        $dbWritable->close(); // 書き込みモードでの接続を閉じる
29        echo "テスト用データベース '{$dbFile}' を作成し、初期データを追加しました。\n";
30    } catch (Exception $e) {
31        echo "データベースの準備中にエラーが発生しました: " . $e->getMessage() . "\n";
32        // エラー発生時は作成したファイルを削除する
33        if (file_exists($dbFile)) {
34            unlink($dbFile);
35        }
36        return; // 処理を終了
37    }
38
39    echo "----------------------------------------\n";
40
41    // --- SQLITE_OPEN_READONLY 定数を使ってデータベースを読み取り専用で開く ---
42    try {
43        // SQLITE3::OPEN_READONLY 定数を使用し、データベースを読み取り専用モードで開きます。
44        // このモードでは、データベースに対する変更操作（INSERT, UPDATE, DELETE）は許可されません。
45        $dbReadOnly = new SQLite3($dbFile, SQLITE3::OPEN_READONLY);
46        echo "データベース '{$dbFile}' を読み取り専用で開きました。\n";
47
48        // 読み取り操作の試行（成功するはず）
49        echo "読み取り専用モードでデータを読み取ります...\n";
50        $results = $dbReadOnly->query('SELECT id, name, price FROM products');
51        if ($results) {
52            echo "読み取ったデータ:\n";
53            while ($row = $results->fetchArray(SQLITE3_ASSOC)) {
54                echo "  ID: {$row['id']}, Name: {$row['name']}, Price: {$row['price']}\n";
55            }
56            $results->finalize(); // 結果セットのリソースを解放
57        } else {
58            echo "データの読み取りに失敗しました。\n";
59        }
60
61        echo "----------------------------------------\n";
62
63        // 書き込み操作の試行（エラーになることを期待）
64        echo "読み取り専用モードで書き込み操作を試行します...\n";
65        // 以下の exec() メソッドは、読み取り専用モードのため Exception を発生させるはずです。
66        $dbReadOnly->exec("INSERT INTO products (name, price) VALUES ('Keyboard', 75.00)");
67        echo "予期せぬ成功: 読み取り専用モードで書き込みができてしまいました。\n"; // この行は通常実行されない
68    } catch (Exception $e) {
69        // 読み取り専用モードでの書き込みは許可されないため、通常はこのブロックに到達します。
70        echo "予期されたエラー: 読み取り専用モードでの書き込みは許可されません。エラー: " . $e->getMessage() . "\n";
71    } finally {
72        // データベース接続を閉じる
73        if (isset($dbReadOnly)) {
74            $dbReadOnly->close();
75            echo "データベース接続を閉じました。\n";
76        }
77    }
78
79    echo "----------------------------------------\n";
80
81    // --- クリーンアップ: 作成したテストファイルを削除 ---
82    if (file_exists($dbFile)) {
83        unlink($dbFile);
84        echo "テスト用データベースファイル '{$dbFile}' を削除しました。\n";
85    }
86}
87
88// 関数の実行
89demonstrateSqliteReadOnlyOpen();

PHP 8におけるSQLITE_OPEN_READONLYは、SQLiteデータベースへの接続時に、そのデータベースを読み取り専用モードで開くために利用される定数です。この定数自体に引数はなく、何らかの処理からの戻り値もありません。主にSQLite3クラスのコンストラクタの第二引数として指定することで、データベースに対する操作の権限を制限します。

この定数を用いてデータベースを開くと、データの参照（読み取り）は可能ですが、データの追加、更新、削除といった書き込み操作は一切許可されません。これにより、重要なデータベースの内容が誤って変更されることを防ぎ、データの安全性を高めることができます。

サンプルコードでは、まず一時的なSQLiteデータベースを作成し、いくつかの初期データを書き込みます。その後、SQLITE_OPEN_READONLY定数を指定して同じデータベースを読み取り専用モードで再度開きます。このモードでSELECT文を実行するとデータが正常に読み取れることを示し、続けてINSERT文を実行しようとすると、読み取り専用であるため書き込みが許可されず、例外が発生してエラーとなる挙動が確認できます。これは、この定数がデータベースへの書き込みを厳密に制限することを示しています。

Copy
1<?php
2
3/**
4 * SQLiteデータベースに読み取り専用モードで接続するサンプルスクリプトです。
5 * SQLITE_OPEN_READONLY 定数を使用して、データベースを読み取り専用で開きます。
6 * システムエンジニアを目指す初心者の方にも理解しやすいよう、必要最低限の機能に絞っています。
7 */
8
9// データベースファイルへのパスを定義します。
10$databaseFile = 'my_readonly_database.db';
11
12// 注意: 読み取り専用モードでデータベースを開く場合、そのファイルが事前に存在している必要があります。
13// 存在しないファイルを読み取り専用モードで開こうとするとエラーになります。
14// デモンストレーションのため、ファイルが存在しない場合は空のファイルを作成します。
15if (!file_exists($databaseFile)) {
16    // ファイルが存在しない場合に空のファイルを作成します。
17    file_put_contents($databaseFile, '');
18    echo "情報: デモンストレーション用に空のデータベースファイルを作成しました: $databaseFile\n";
19}
20
21try {
22    // PDO (PHP Data Objects) を使用してデータベースに接続します。
23    // 第1引数: DSN (Data Source Name) - データベースの種類とパスを指定します。
24    // 第2引数, 第3引数: ユーザー名, パスワード (SQLiteの場合は通常不要なのでnull)
25    // 第4引数: オプション配列 - ここで PDO::SQLITE_OPEN_READONLY 定数を指定します。
26    $pdo = new PDO(
27        "sqlite:$databaseFile",
28        null,
29        null,
30        [
31            PDO::ATTR_ERRMODE           => PDO::ERRMODE_EXCEPTION, // エラー発生時に例外をスローする設定
32            PDO::SQLITE_OPEN_READONLY                          // データベースを読み取り専用モードで開く
33        ]
34    );
35
36    echo "SQLiteデータベースに読み取り専用モードで正常に接続しました。\n";
37
38    // 読み取り操作の例: データベース内のテーブル名を取得
39    $stmt = $pdo->query("SELECT name FROM sqlite_master WHERE type='table';");
40    $tables = $stmt->fetchAll(PDO::FETCH_COLUMN);
41
42    if (empty($tables)) {
43        echo "データベース内にテーブルは見つかりませんでした。\n";
44    } else {
45        echo "データベース内のテーブル: " . implode(', ', $tables) . "\n";
46    }
47
48    // 読み取り専用モードであるため、書き込み操作を試みるとエラー（例外）が発生します。
49    // 以下の行をコメントアウト解除して実行すると、PDOExceptionが発生することが確認できます。
50    /*
51    $pdo->exec("CREATE TABLE IF NOT EXISTS test_table (id INTEGER PRIMARY KEY, name TEXT);");
52    echo "テーブル作成を試みました (読み取り専用モードのため、通常は失敗します)。\n";
53    */
54
55} catch (PDOException $e) {
56    // データベース接続または操作中にエラーが発生した場合
57    echo "データベース接続または操作に失敗しました: " . $e->getMessage() . "\n";
58} finally {
59    // データベース接続を閉じます。
60    // PDOオブジェクトをnullにすることで接続が解放されます。
61    $pdo = null;
62    echo "データベース接続を閉じました。\n";
63
64    // デモンストレーション用に作成したファイルを削除する場合（必要に応じてコメントアウト解除）
65    // if (file_exists($databaseFile)) {
66    //     unlink($databaseFile);
67    //     echo "情報: デモンストレーション用のデータベースファイルを削除しました。\n";
68    // }
69}
70
71?>

このPHPスクリプトは、PDO（PHP Data Objects）を使用してSQLiteデータベースに「読み取り専用」モードで接続する方法を説明します。PDO::SQLITE_OPEN_READONLYは、データベースを読み取り専用で開くための特別な定数で、データベースファイルへの変更を禁止します。この定数自体には引数や戻り値はありませんが、new PDO()コンストラクタのオプション配列に含めることでその機能を発揮します。

コードでは、まずデータベースファイルへのパスを定義し、デモンストレーション用にファイルが存在しない場合は空のファイルを作成します。次に、try-catchブロック内でnew PDO()を使ってデータベースに接続します。ここで、第4引数のオプション配列にPDO::SQLITE_OPEN_READONLYを指定している点が重要です。これにより、データベースへの書き込み操作が試みられるとエラー（PDOException）が発生するようになります。接続が成功すると、データベース内のテーブル名を読み取る例が示されます。最後にfinallyブロックでデータベース接続を閉じ、リソースを解放します。この機能は、データの安全性を高めたい場合や、閲覧専用のアプリケーションで特に役立ちます。