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

Copy
1<?php
2
3/**
4 * SQLITE3_OPEN_READONLY 定数を使用して、SQLiteデータベースを読み取り専用で開くサンプルコード。
5 */
6function demonstrateSqliteReadonlyOpen(): void
7{
8    $dbFile = 'sample.db'; // 使用するSQLiteデータベースファイル名
9
10    // データベースファイルが存在しない場合、作成して初期データを投入する
11    // これは、読み取り専用モードで開く前に、ファイルとデータが存在する必要があるためです。
12    if (!file_exists($dbFile)) {
13        try {
14            // 読み書きモードでデータベースを開き、ファイルとテーブル、初期データを作成
15            $db = new SQLite3($dbFile, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE);
16            $db->exec('CREATE TABLE IF NOT EXISTS products (id INTEGER PRIMARY KEY, name TEXT, price REAL)');
17            $db->exec("INSERT INTO products (name, price) VALUES ('Apple', 1.0)");
18            $db->close();
19            echo "データベースファイル '{$dbFile}' を作成し、初期データを投入しました。\n\n";
20        } catch (Exception $e) {
21            echo "データベースの初期化に失敗しました: " . $e->getMessage() . "\n";
22            return;
23        }
24    }
25
26    $db = null; // データベース接続オブジェクトを初期化
27
28    try {
29        // SQLITE3_OPEN_READONLY 定数を使用して、データベースを読み取り専用で開く
30        // このモードでは、データベースの内容を変更することはできません。
31        echo "データベース '{$dbFile}' を読み取り専用モードで開きます。\n";
32        $db = new SQLite3($dbFile, SQLITE3_OPEN_READONLY);
33        echo "データベースを読み取り専用で開きました。\n";
34
35        // 読み取り操作の例: データベースからデータをSELECTする
36        echo "\n--- 商品データ ---\n";
37        $results = $db->query('SELECT id, name, price FROM products');
38        if ($results) {
39            while ($row = $results->fetchArray(SQLITE3_ASSOC)) {
40                echo "ID: " . $row['id'] . ", 名前: " . $row['name'] . ", 価格: " . $row['price'] . "\n";
41            }
42        } else {
43            echo "データの取得に失敗しました: " . $db->lastErrorMsg() . "\n";
44        }
45
46        // 読み取り専用モードでの書き込み操作を試みる（失敗するはずです）
47        echo "\n書き込み操作を試みます（読み取り専用のため失敗します）...\n";
48        $insertSuccess = $db->exec("INSERT INTO products (name, price) VALUES ('Orange', 0.75)");
49        if (!$insertSuccess) {
50            echo "書き込み操作に失敗しました (期待通り): " . $db->lastErrorMsg() . "\n";
51        } else {
52            echo "書き込み操作が成功してしまいました (予期せぬ動作)。\n";
53        }
54
55    } catch (Exception $e) {
56        // データベースのオープン中にエラーが発生した場合
57        echo "データベースのオープン中にエラーが発生しました: " . $e->getMessage() . "\n";
58    } finally {
59        // データベース接続が開いている場合は閉じる
60        if ($db instanceof SQLite3) {
61            $db->close();
62            echo "\nデータベース接続を閉じました。\n";
63        }
64    }
65
66    // 必要に応じて、テスト用のデータベースファイルを削除する
67    // unlink($dbFile);
68}
69
70// 関数を実行する
71demonstrateSqliteReadonlyOpen();

PHPのSQLITE3_OPEN_READONLYは、SQLiteデータベースを「読み取り専用」モードで開くための定数です。これは整数型の値を持ち、引数は取りません。この定数を使用すると、データベースからデータを読み出すことはできますが、データの追加、更新、削除といった書き込み操作は一切許可されません。

サンプルコードでは、まずsample.dbというSQLiteデータベースファイルが存在しない場合、一時的に読み書きモードで作成し、初期データを投入しています。これは、読み取り専用で開く対象のデータベースとデータが必要なためです。

その後、new SQLite3($dbFile, SQLITE3_OPEN_READONLY)のように、この定数を用いてデータベースを読み取り専用で開きます。開いたデータベースからSELECT文でデータを読み出す操作は正常に実行され、結果が表示されます。しかし、INSERT文で新しいデータを書き込もうとすると、読み取り専用モードのためエラーが発生し、書き込みが失敗することが確認できます。

この定数は、アプリケーションが誤って重要なデータを変更してしまうことを防ぎたい場合や、設定ファイルなど参照のみで十分なデータベースを扱う場合に非常に役立ちます。データベース接続は、最終的にfinallyブロックで確実に閉じられています。

Copy
1<?php
2
3/**
4 * SQLITE3_OPEN_READONLY定数の使用例
5 *
6 * このスクリプトは、SQLiteデータベースを読み取り専用モードで開く方法を示します。
7 * データベースの作成、データの読み込み、および読み取り専用モードでの書き込み試行を通じて、
8 * SQLITE3_OPEN_READONLY定数の動作を実演します。
9 */
10
11// テスト用のSQLiteデータベースファイルパス
12$dbFile = 'my_sample_readonly_db.sqlite';
13
14/**
15 * ヘルパー関数: テスト用のSQLiteデータベースを作成し、初期データを挿入します。
16 * データベースが既に存在する場合は、上書きせずに初期データのみ挿入します。
17 *
18 * @param string $path データベースファイルのパス。
19 */
20function createOrPopulateDatabase(string $path): void
21{
22    echo "--- データベース準備中 ---\n";
23    try {
24        // データベースを読み書きモードで開き、テーブルと初期データを作成
25        $db = new SQLite3($path);
26        echo "データベース '$path' を作成または開きました。\n";
27
28        $db->exec('CREATE TABLE IF NOT EXISTS products (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, price REAL)');
29        echo "テーブル 'products' を確認しました。\n";
30
31        // 初期データが存在しない場合のみ挿入
32        $result = $db->querySingle("SELECT COUNT(*) FROM products WHERE name = 'Laptop'");
33        if ($result == 0) {
34            $db->exec("INSERT INTO products (name, price) VALUES ('Laptop', 1200.50)");
35            $db->exec("INSERT INTO products (name, price) VALUES ('Mouse', 25.00)");
36            echo "初期データを挿入しました。\n";
37        } else {
38            echo "初期データは既に存在します。\n";
39        }
40        $db->close();
41        echo "データベース準備完了。\n\n";
42    } catch (Exception $e) {
43        echo "エラー: データベース準備中に問題が発生しました: " . $e->getMessage() . "\n";
44        // エラーが発生した場合は終了
45        exit(1);
46    }
47}
48
49// --- メイン処理 ---
50
51// データベースが存在しない場合は作成し、初期データを挿入
52if (!file_exists($dbFile)) {
53    createOrPopulateDatabase($dbFile);
54} else {
55    echo "データベース '$dbFile' は既に存在します。既存のデータを使用します。\n\n";
56}
57
58$db = null; // SQLite3オブジェクトの初期化
59try {
60    echo "--- SQLITE3_OPEN_READONLY のデモンストレーション ---\n";
61
62    // 1. SQLITE3_OPEN_READONLY定数を使用してデータベースを読み取り専用で開く
63    echo "データベース '$dbFile' を読み取り専用モードで開きます...\n";
64    $db = new SQLite3($dbFile, SQLITE3_OPEN_READONLY);
65    echo "データベースは読み取り専用モードで正常に開かれました。\n\n";
66
67    // 2. データの読み込みを試行 (成功するはず)
68    echo "データを読み込みます:\n";
69    $results = $db->query('SELECT id, name, price FROM products');
70    if ($results) {
71        while ($row = $results->fetchArray(SQLITE3_ASSOC)) {
72            echo "  ID: " . $row['id'] . ", 名前: " . $row['name'] . ", 価格: " . $row['price'] . "\n";
73        }
74        echo "読み込み操作は成功しました。\n\n";
75    } else {
76        echo "エラー: データの読み込みに失敗しました: " . $db->lastErrorMsg() . "\n\n";
77    }
78
79    // 3. データの書き込みを試行 (失敗するはず)
80    echo "新しいデータを挿入しようとします (これは失敗するはずです):\n";
81    if ($db->exec("INSERT INTO products (name, price) VALUES ('Keyboard', 75.00)")) {
82        echo "予期せぬ成功: 読み取り専用モードで書き込みが成功しました。\n\n";
83    } else {
84        // exec()は失敗時にfalseを返すため、lastErrorMsg()とlastErrorCode()で詳細を確認
85        echo "期待通り: 書き込み操作は失敗しました。エラー: " . $db->lastErrorMsg() . " (エラーコード: " . $db->lastErrorCode() . ")\n";
86        // SQLITE_READONLYのエラーコードは通常8
87        if ($db->lastErrorCode() === 8) {
88            echo "データベースが読み取り専用モードであることを確認しました。\n\n";
89        } else {
90            echo "注意: エラーコード " . $db->lastErrorCode() . " は別の問題を示しています。\n\n";
91        }
92    }
93
94} catch (Exception $e) {
95    // データベースのオープン失敗など、SQLite3コンストラクタが例外を投げる場合
96    echo "致命的なエラー: " . $e->getMessage() . "\n";
97} finally {
98    // 4. データベース接続をクローズ
99    if ($db) {
100        $db->close();
101        echo "データベース接続をクローズしました。\n";
102    }
103
104    // 5. テスト用データベースファイルをクリーンアップ
105    // 実際の運用では削除しませんが、サンプルコードとしてはクリーンアップします。
106    if (file_exists($dbFile)) {
107        unlink($dbFile);
108        echo "テスト用データベースファイル '$dbFile' を削除しました。\n";
109    }
110}
111
112?>

PHPのSQLITE3_OPEN_READONLYは、PHP 8でSQLiteデータベースを扱う際に利用される重要な定数です。この定数は、SQLiteデータベースへの接続を読み取り専用モードで確立するために使用されます。具体的な値は整数型（int）であり、引数は持ちません。

SQLite3クラスのコンストラクタの第二引数としてこの定数を指定すると、該当のデータベースファイルはデータの読み込みのみが許可され、データの挿入、更新、削除といった書き込み操作はブロックされます。これにより、プログラムが誤ってデータを変更してしまうことを防ぎ、データベースのデータ保全性を高めることができます。

サンプルコードでは、まずテスト用のデータベースを作成し、初期データを準備しています。その後、new SQLite3($dbFile, SQLITE3_OPEN_READONLY)という形でデータベースを読み取り専用モードで開く様子を示しています。このモードで開かれたデータベースに対してSELECT文でデータを取得する操作は成功しますが、INSERT文でデータを追加しようとすると、期待通りエラーが発生して失敗します。この挙動は、SQLITE3_OPEN_READONLY定数がデータベースへの書き込みを正確に禁止していることを明確に実演しており、読み取り専用接続が必要な場合に大変役立ちます。