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

Copy
1<?php
2
3/**
4 * SQLite3Result::numColumns() の使用例を示す関数です。
5 * SELECTクエリの結果セットの列数を取得します。
6 * システムエンジニアを目指す初心者向けに、単体で動作する簡潔なコードです。
7 */
8function demonstrateNumColumns(): void
9{
10    // SQLite3 データベースをメモリ上に作成（一時的なデータベース）
11    // ファイルとして永続化する場合は、':memory:' の代わりにファイルパスを指定します（例: 'my_database.db'）
12    $db = new SQLite3(':memory:');
13
14    if (!$db) {
15        echo "エラー: データベースのオープンに失敗しました。\n";
16        return;
17    }
18
19    // テーブルを作成
20    $createTableSql = "
21        CREATE TABLE IF NOT EXISTS products (
22            id INTEGER PRIMARY KEY AUTOINCREMENT,
23            name TEXT NOT NULL,
24            price REAL
25        )
26    ";
27    if (!$db->exec($createTableSql)) {
28        echo "エラー: テーブル作成に失敗しました: " . $db->lastErrorMsg() . "\n";
29        $db->close();
30        return;
31    }
32
33    // データを挿入
34    $db->exec("INSERT INTO products (name, price) VALUES ('Apple', 1.00)");
35    $db->exec("INSERT INTO products (name, price) VALUES ('Banana', 0.50)");
36
37    // SELECT クエリを実行し、結果セットを取得
38    // ここでは 'id', 'name', 'price' の3つの列を選択しています
39    $selectSql = "SELECT id, name, price FROM products";
40    $result = $db->query($selectSql);
41
42    if (!$result) {
43        echo "エラー: クエリの実行に失敗しました: " . $db->lastErrorMsg() . "\n";
44        $db->close();
45        return;
46    }
47
48    // SQLite3Result::numColumns() を使用して、結果セットの列数を取得します。
49    // このメソッドは、SELECT文で指定された列（カラム）の数を整数で返します。
50    $numColumns = $result->numColumns();
51    echo "SELECTクエリの結果セットの列数: " . $numColumns . "列\n"; // この例では '3列' が出力されます
52
53    // 結果セットを解放します
54    $result->finalize();
55
56    // データベース接続を閉じます
57    $db->close();
58}
59
60// 上記で定義した関数を実行します
61demonstrateNumColumns();

このPHPサンプルコードは、SQLite3Result::numColumns()メソッドの使い方を実演しています。このメソッドは、データベースからデータを取得するSELECTクエリの結果セットが、いくつの列（カラム）で構成されているかを知るために使用されます。引数は不要で、結果として列の総数を整数値で返します。

コードではまず、一時的なSQLite3データベースをメモリ上に作成し、productsという名前のテーブルを用意してサンプルデータを挿入しています。次に、SELECT id, name, price FROM productsというクエリを実行し、その結果を$result変数に格納します。ここで$result->numColumns()を呼び出すと、選択されたid、name、priceの3つの列数を正確に取得し、その値を出力します。このように、numColumns()はクエリが返すデータの構造（列の数）をプログラムで確認する際に役立つメソッドです。処理の最後には、結果セットとデータベース接続が適切に閉じられています。

Copy
1<?php
2
3/**
4 * SQLite3Result::numColumns() メソッドの使用例を示します。
5 * このメソッドは、SQLクエリの結果セットに含まれる列の数を返します。
6 * キーワード 'num_rows' (行数) とは異なり、選択された列の数を取得します。
7 */
8function demonstrateNumColumnsExample(): void
9{
10    // データベースファイル名。存在しない場合は新規作成されます。
11    $dbFile = 'my_database.sqlite';
12
13    // データベースに接続
14    $db = new SQLite3($dbFile);
15    if (!$db) {
16        die("データベース接続エラー: " . $db->lastErrorMsg());
17    }
18
19    // users テーブルが存在しない場合に作成。
20    // このテーブルは id, name, email の3つの列を持ちます。
21    $createTableSql = 'CREATE TABLE IF NOT EXISTS users (
22        id INTEGER PRIMARY KEY AUTOINCREMENT,
23        name TEXT NOT NULL,
24        email TEXT NOT NULL UNIQUE
25    )';
26    if (!$db->exec($createTableSql)) {
27        die("テーブル作成エラー: " . $db->lastErrorMsg());
28    }
29
30    // サンプルデータを挿入（既に同じemailが存在する場合は無視）
31    // この操作は結果セットの列数には影響しませんが、データの確認のために含めています。
32    $db->exec("INSERT OR IGNORE INTO users (name, email) VALUES ('Alice', 'alice@example.com')");
33    $db->exec("INSERT OR IGNORE INTO users (name, email) VALUES ('Bob', 'bob@example.com')");
34    $db->exec("INSERT OR IGNORE INTO users (name, email) VALUES ('Charlie', 'charlie@example.com')");
35
36    // 全てのユーザーデータを取得するクエリを実行
37    // ここでは 'id', 'name', 'email' の3つの列を選択しています。
38    $querySql = 'SELECT id, name, email FROM users';
39    $result = $db->query($querySql);
40
41    if ($result instanceof SQLite3Result) {
42        // SQLite3Result::numColumns() を呼び出して、結果セットの列数を取得します。
43        // これは、SELECT文で指定した列の数と一致します。
44        $numColumns = $result->numColumns();
45
46        echo "クエリ結果の列数: " . $numColumns . PHP_EOL; // 例: 3
47
48        // 結果セットからデータを取得し、表示する例（オプション）
49        echo "--- 取得データ ---" . PHP_EOL;
50        while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
51            echo "ID: " . $row['id'] . ", 名前: " . $row['name'] . ", メール: " . $row['email'] . PHP_EOL;
52        }
53
54        // 結果セットオブジェクトを解放します。
55        $result->finalize();
56    } else {
57        echo "クエリ実行エラー: " . $db->lastErrorMsg() . PHP_EOL;
58    }
59
60    // データベース接続を閉じます。
61    $db->close();
62
63    // 例として作成したデータベースファイルを削除（通常、本番環境では行いません）
64    // unlink($dbFile);
65}
66
67// 関数を実行して、SQLite3Result::numColumns() の動作を確認します。
68demonstrateNumColumnsExample();

PHPのSQLite3Result::numColumns()メソッドは、SQLクエリを実行して得られた結果（結果セット）に含まれる「列（カラム）の数」を取得するために使用されます。これは、取得したデータの行数を示す「num_rows」のようなメソッドとは異なり、SELECT文で指定した項目の総数を把握する際に役立ちます。

このメソッドは引数を取りません。呼び出すと、結果セットの列数を表す整数（int）を返します。

提供されたサンプルコードでは、まずSQLiteデータベースに接続し、「users」テーブルの作成とサンプルデータの挿入を行っています。その後、SELECT id, name, email FROM usersというSQLクエリを実行し、id、name、emailの3つの列を選択した結果をSQLite3Resultオブジェクトとして取得しています。

$result->numColumns()を呼び出すことで、この結果セットが持つ列の数を正確に取得できます。上記のクエリの場合、このメソッドは「3」という値を返します。取得した列数は、プログラムで結果の構造を動的に判断し、処理を行う際に活用できます。最後に、データベースへの接続を閉じ、リソースを解放しています。