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

Copy
1<?php
2
3/**
4 * PDOStatement::columnCount() メソッドのサンプルコード
5 * データベースクエリの結果セットに含まれる列の数を取得します。
6 */
7
8try {
9    // 1. SQLiteのインメモリデータベースに接続します。
10    //    これにより、ファイルに依存せず単体で動作するサンプルとなります。
11    $pdo = new PDO('sqlite::memory:');
12
13    // エラーモードを例外に設定し、エラー発生時にPDOExceptionをスローするようにします。
14    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
15
16    echo "データベースに接続しました。\n\n";
17
18    // 2. テスト用のテーブルを作成します。
19    $pdo->exec("
20        CREATE TABLE IF NOT EXISTS products (
21            id INTEGER PRIMARY KEY,
22            name TEXT NOT NULL,
23            price REAL NOT NULL,
24            category TEXT
25        )
26    ");
27    echo "テーブル 'products' を作成しました。\n";
28
29    // 3. テーブルにデータを挿入します（任意ですが、より実践的な例になります）。
30    $pdo->exec("INSERT INTO products (name, price, category) VALUES ('Laptop', 1200.00, 'Electronics')");
31    $pdo->exec("INSERT INTO products (name, price, category) VALUES ('Mouse', 25.50, 'Electronics')");
32    echo "データを挿入しました。\n\n";
33
34    // 4. SQLクエリを準備します。
35    //    ここでは、'products' テーブルから 'name' と 'price' の2つの列を選択しています。
36    $stmt = $pdo->prepare("SELECT name, price FROM products");
37
38    // 5. クエリを実行します。
39    $stmt->execute();
40
41    // 6. PDOStatement::columnCount() メソッドを使用して、結果セットの列数を取得します。
42    $columnCount = $stmt->columnCount();
43
44    echo "実行したクエリ: 'SELECT name, price FROM products'\n";
45    echo "このクエリの結果セットには {$columnCount} 個の列があります。\n\n";
46
47    // 別バージョンのクエリで列数の変化を確認
48    // 7. すべての列を選択するクエリを準備・実行します。
49    $stmtAll = $pdo->prepare("SELECT id, name, price, category FROM products");
50    $stmtAll->execute();
51    $columnCountAll = $stmtAll->columnCount();
52
53    echo "実行したクエリ: 'SELECT id, name, price, category FROM products'\n";
54    echo "このクエリの結果セットには {$columnCountAll} 個の列があります。\n";
55
56} catch (PDOException $e) {
57    // データベース関連のエラーが発生した場合に、そのメッセージを表示します。
58    echo "データベースエラー: " . $e->getMessage() . "\n";
59} catch (Exception $e) {
60    // その他の予期せぬエラーが発生した場合に、そのメッセージを表示します。
61    echo "エラー: " . $e->getMessage() . "\n";
62}
63
64?>

PDOStatement::columnCount()メソッドは、PHPのデータベース拡張であるPDOを使用してSQLクエリを実行した際、その結果セットに含まれる列（カラム）の数を取得するために利用されます。このメソッドは、PDOStatementクラスのインスタンスに対して呼び出され、引数を必要とせず、常に現在の結果セットの列数を整数値で返します。

サンプルコードでは、まずSQLiteのインメモリデータベースに接続し、productsテーブルを作成してダミーデータを挿入しています。その後、「SELECT name, price FROM products」というSQLクエリを準備し実行します。このクエリはproductsテーブルからnameとpriceの2つの列を選択するため、結果セットには2つの列が含まれます。

クエリ実行後、$stmt->columnCount()を呼び出すことで、結果セットの列数である2という整数値が取得され、画面に表示されます。同様に、「SELECT id, name, price, category FROM products」という別のクエリでは、選択された4つの列に対応してcolumnCount()は4を返します。

この機能は、取得したデータの構造が動的に変化する場合や、特定の列数を持つ結果を期待するバリデーションなど、データ処理のロジックを柔軟に構築する際に役立ちます。エラーが発生した場合にはtry-catchブロックによって適切に捕捉され、メッセージが表示されるようになっています。

Copy
1<?php
2
3/**
4 * PDOStatement::columnCount() の使用例。
5 * このメソッドは、データベースのクエリ結果に含まれるカラム（列）の数を返します。
6 * システムエンジニアを目指す初心者の方にも分かりやすいよう、単体で動作する簡潔なコードです。
7 */
8
9try {
10    // 1. PDOオブジェクトを作成し、SQLiteメモリデータベースに接続します。
11    // 'sqlite::memory:' は、一時的なインメモリデータベースを作成するため、
12    // 実際のファイルを作成せずにテストできます。
13    // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定することで、
14    // データベース操作中にエラーが発生した場合にPDOExceptionがスローされ、
15    // エラーハンドリングが容易になります。
16    $pdo = new PDO('sqlite::memory:');
17    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
18
19    echo "データベースに接続しました。\n";
20
21    // 2. テスト用のテーブルを作成します。
22    // CREATE TABLE IF NOT EXISTS は、テーブルが存在しない場合のみ作成します。
23    $pdo->exec("
24        CREATE TABLE IF NOT EXISTS users (
25            id INTEGER PRIMARY KEY AUTOINCREMENT,
26            name VARCHAR(50) NOT NULL,
27            email VARCHAR(100) UNIQUE NOT NULL
28        )
29    ");
30    echo "usersテーブルを作成しました。\n";
31
32    // 3. テストデータを挿入します。
33    $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com')");
34    $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com')");
35    echo "テストデータを挿入しました。\n";
36
37    // 4. SELECT文を準備します。
38    // PDO::prepare() はSQLインジェクション攻撃を防ぐために重要です。
39    // このクエリでは 'id', 'name', 'email' の3つのカラムを選択しています。
40    $stmt = $pdo->prepare("SELECT id, name, email FROM users");
41
42    // 5. プリペアドステートメントを実行します。
43    // columnCount() メソッドは、通常 execute() メソッドが成功した後で呼び出されます。
44    $stmt->execute();
45    echo "SELECTクエリを実行しました。\n";
46
47    // 6. PDOStatement::columnCount() を使用して、結果セットのカラム数を取得します。
48    // このメソッドは引数を取りません。
49    $columnCount = $stmt->columnCount();
50
51    echo "結果セットのカラム数: " . $columnCount . "\n"; // 期待される出力は 3
52
53    // 異なるクエリで再度試してみます。
54    // 今度は 'name' と 'email' の2つのカラムのみを選択します。
55    $stmt2 = $pdo->prepare("SELECT name, email FROM users");
56    $stmt2->execute();
57    $columnCount2 = $stmt2->columnCount();
58    echo "異なるクエリ(name, emailのみ)のカラム数: " . $columnCount2 . "\n"; // 期待される出力は 2
59
60} catch (PDOException $e) {
61    // データベース接続やクエリ実行中にエラーが発生した場合、ここに処理が移ります。
62    echo "エラーが発生しました: " . $e->getMessage() . "\n";
63}
64
65?>

PDOStatement::columnCount()メソッドは、データベースに対するクエリを実行した結果に含まれるカラム（列）の数を取得するために使用されます。このメソッドは、PDOStatementオブジェクトのexecute()メソッドが成功した後に呼び出されることが一般的です。引数を一切取らず、戻り値として結果セット内のカラム数を整数（int）で返します。

サンプルコードでは、まずSQLiteメモリデータベースに接続し、usersテーブルを作成してテストデータを挿入しています。その後、「SELECT id, name, email FROM users」というSQLクエリを準備・実行し、$stmt->columnCount()を呼び出すことで、選択された3つのカラム（id, name, email）の数である「3」が取得されます。さらに、「SELECT name, email FROM users」のように異なるクエリで2つのカラムのみを選択した場合でも、正しく「2」という数が返されることを確認できます。

このメソッドは、データベースのスキーマ情報を動的に取得したり、クエリ結果の構造に基づいてプログラムの処理を分岐させたりする際に役立ちます。システムエンジニアを目指す方にとって、データベースからの情報取得は基本的な操作であり、このようなユーティリティメソッドの理解は、堅牢なアプリケーション開発に繋がる重要な知識です。