【PHP8.x】SQLite3Result::columnName()メソッドの使い方

Copy
1<?php
2
3/**
4 * SQLite3Result::columnName() メソッドの使用例
5 *
6 * このスクリプトは、SQLiteデータベースに接続し、テーブルを作成してデータを挿入した後、
7 * SELECTクエリの結果から各列の名前を取得して表示します。
8 * SQLite3Result::columnName() メソッドは、指定された列インデックスに対応する列名を返します。
9 */
10
11// データベースファイルのパスを定義
12$dbFile = 'example.db';
13
14// データベース接続オブジェクトを初期化
15$sqlite = null;
16
17try {
18    // SQLiteデータベースに接続（ファイルが存在しない場合は新規作成）
19    $sqlite = new SQLite3($dbFile);
20    echo "データベース '{$dbFile}' に接続しました。\n";
21
22    // テーブルが存在しない場合のみ作成
23    $sqlite->exec('CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)');
24    echo "テーブル 'users' の存在を確認または作成しました。\n";
25
26    // テストデータを挿入（データがまだない場合）
27    $countResult = $sqlite->querySingle('SELECT COUNT(*) FROM users');
28    if ($countResult === 0) {
29        $sqlite->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com')");
30        $sqlite->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@bob.com')");
31        echo "テストデータを挿入しました。\n";
32    } else {
33        echo "テストデータは既に存在します。\n";
34    }
35
36    // SELECT クエリを実行し、結果セットを取得
37    // SQLite3::query() は SQLite3Result オブジェクトを返します
38    $results = $sqlite->query('SELECT id, name, email FROM users');
39
40    if ($results instanceof SQLite3Result) {
41        echo "\n取得した結果セットの列名:\n";
42
43        // 結果セットの列数を取得
44        $numColumns = $results->numColumns();
45
46        // 各列のインデックスと名前を表示
47        for ($i = 0; $i < $numColumns; $i++) {
48            // SQLite3Result::columnName() を使用して、指定されたインデックスの列名を取得
49            $columnName = $results->columnName($i);
50            echo "  - 列インデックス {$i}: {$columnName}\n";
51        }
52
53        // 結果セットオブジェクトを解放
54        $results->finalize();
55    } else {
56        echo "クエリの実行に失敗しました: " . $sqlite->lastErrorMsg() . "\n";
57    }
58
59} catch (Exception $e) {
60    echo "エラーが発生しました: " . $e->getMessage() . "\n";
61} finally {
62    // データベース接続を閉じる
63    if ($sqlite) {
64        $sqlite->close();
65        echo "\nデータベース接続を閉じました。\n";
66    }
67    // 例として、作成したデータベースファイルを削除することもできます
68    // unlink($dbFile);
69    // echo "データベースファイル '{$dbFile}' を削除しました。\n";
70}

このPHPサンプルコードは、SQLiteデータベースを操作し、特にSQLite3Result::columnName()メソッドの具体的な使い方を示しています。まず、SQLiteデータベースファイルに接続または新規作成し、「users」テーブルを作成してテストデータを挿入します。

データ挿入後、「users」テーブルからid, name, emailの各列を選択するSQLクエリを実行します。SQLite3::query()メソッドは、このクエリの実行結果をSQLite3Resultオブジェクトとして返します。

SQLite3Result::columnName()メソッドは、このSQLite3Resultオブジェクトが保持する結果セットに含まれる特定の列の名前を取得するために使用されます。このメソッドは引数として、列のインデックスを整数値（int $column）で受け取ります。インデックスは通常0から始まります。指定されたインデックスに対応する列名が見つかると、その列名が文字列（string）として戻り値で返されます。

このコードでは、numColumns()メソッドで取得した列の総数分だけループ処理を行い、各インデックスをcolumnName()に渡しています。これにより、0番目の列が「id」、1番目の列が「name」、2番目の列が「email」といった具体的な列名が取得され、それぞれが出力されます。このメソッドを使うことで、データベースのスキーマ情報を直接参照することなく、クエリ結果から動的に列名を知ることが可能です。最後に、データベース接続を安全に閉じ、結果セットも解放しています。

Copy
1<?php
2
3/**
4 * SQLite3 データベースからクエリ結果のカラム名を取得する方法を示す関数。
5 * システムエンジニアを目指す初心者向けに、`SQLite3Result::columnName` の使用方法を解説します。
6 *
7 * この関数は、SQLite3 データベースへの接続、テーブル作成、データ挿入、
8 * そしてクエリ結果からカラム名を取得する一連の流れを示します。
9 */
10function demonstrateSQLite3ColumnName(): void
11{
12    // 1. SQLite3 データベースファイル 'my_database.db' に接続します。
13    //    指定されたファイルが存在しない場合は新しく作成されます。
14    $db = new SQLite3('my_database.db');
15
16    // 2. 'users' テーブルが存在しない場合は作成します。
17    //    id (INTEGER PRIMARY KEY AUTOINCREMENT): 自動的に増えるユニークなID（主キー）
18    //    name (TEXT): ユーザーの名前
19    //    email (TEXT): ユーザーのメールアドレス
20    $db->exec('CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, email TEXT)');
21
22    // 3. サンプルデータを 'users' テーブルに挿入します。
23    //    'INSERT OR IGNORE' を使用することで、同じ id のデータが既に存在する場合は挿入をスキップし、
24    //    スクリプトを複数回実行しても重複するデータが追加されるのを防ぎます。
25    $db->exec("INSERT OR IGNORE INTO users (id, name, email) VALUES (1, 'Alice', 'alice@example.com')");
26    $db->exec("INSERT OR IGNORE INTO users (id, name, email) VALUES (2, 'Bob', 'bob@example.com')");
27    $db->exec("INSERT OR IGNORE INTO users (id, name, email) VALUES (3, 'Charlie', 'charlie@example.com')");
28
29    // 4. 'users' テーブルから全てのレコードの id, name, email カラムを選択するクエリを実行します。
30    //    クエリの結果は `SQLite3Result` オブジェクトとして返されます。
31    $results = $db->query('SELECT id, name, email FROM users');
32
33    // 5. クエリが成功し、`SQLite3Result` オブジェクトが返されたことを確認します。
34    if ($results instanceof SQLite3Result) {
35        // 6. 結果セットに含まれるカラムの総数を取得します。
36        //    これは、ループで各カラムにアクセスするために必要です。
37        $numColumns = $results->numColumns();
38        echo "クエリ結果には " . $numColumns . " 個のカラムが検出されました。\n";
39        echo "以下に、各カラムの名前を示します:\n";
40
41        // 7. ループを使って、各カラムのインデックス (0から始まる) を指定し、
42        //    `columnName` メソッドでそのカラムの名前を取得して表示します。
43        //    `SQLite3Result::columnName(int $column)` は、指定されたインデックスのカラム名を文字列で返します。
44        for ($i = 0; $i < $numColumns; $i++) {
45            $columnName = $results->columnName($i); // ここで `SQLite3Result::columnName` メソッドを使用
46            echo "- カラムインデックス " . $i . ": " . $columnName . "\n";
47        }
48
49        // 8. 結果セットのリソースを解放します。
50        //    これにより、メモリが効率的に使用され、システムリソースが適切に管理されます。
51        $results->close();
52    } else {
53        // クエリの実行に失敗した場合のエラーメッセージを表示します。
54        echo "エラー: クエリの実行に失敗しました。\n";
55    }
56
57    // 9. データベース接続を閉じます。
58    //    これにより、データベースファイルへのロックが解除され、リソースが解放されます。
59    $db->close();
60}
61
62// 定義した関数を実行します。
63demonstrateSQLite3ColumnName();
64
65?>

このPHPサンプルコードは、SQLite3データベースからクエリ結果のカラム名を取得する方法を、初心者の方にも分かりやすく解説しています。まず、SQLite3クラスを使用してデータベースファイルに接続し、必要に応じてusersテーブルを作成し、サンプルデータを挿入します。

その後、SELECT文でクエリを実行すると、その結果はSQLite3Resultオブジェクトとして取得されます。このオブジェクトが、クエリで取得されたデータだけでなく、カラムに関する情報も保持しています。

コードの核心となるのはSQLite3Result::columnNameメソッドです。このメソッドは、引数として指定された0から始まる整数値のインデックス（int $column）に対応するカラムの名前を、文字列（string）として返します。例えば、$results->columnName(0)は結果セットの最初のカラムの名前を、$results->columnName(1)は二番目のカラムの名前を取得できます。サンプルではnumColumns()でカラム数を取得し、ループを使って全てのリザルトカラム名を順に表示しています。

最後に、データベース接続と結果セットのリソースはclose()メソッドで適切に解放され、システムリソースが効率的に管理されています。