【PHP8.x】PDO::FETCH_COLUMN定数の使い方

Copy
1<?php
2
3try {
4    // 1. SQLite インメモリデータベースに接続（テスト用）
5    // 実際のアプリケーションでは、ファイルパスや他のデータベース接続情報を使用します。
6    $pdo = new PDO('sqlite::memory:');
7    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); // エラー時に例外を投げるように設定
8
9    // 2. テスト用のテーブルを作成し、サンプルデータを挿入
10    $pdo->exec("CREATE TABLE products (id INTEGER PRIMARY KEY, name TEXT, price REAL)");
11    $pdo->exec("INSERT INTO products (name, price) VALUES ('Laptop', 1200.00)");
12    $pdo->exec("INSERT INTO products (name, price) VALUES ('Mouse', 25.50)");
13    $pdo->exec("INSERT INTO products (name, price) VALUES ('Keyboard', 75.00)");
14
15    echo "データベースの準備とデータ挿入が完了しました。\n\n";
16
17    // 3. PDO::FETCH_COLUMN を使用して、特定のカラム（例: name）の値のみを全て取得する
18    echo "--- 商品名（nameカラム）だけをリストとして取得 ---\n";
19    $stmt = $pdo->prepare("SELECT name FROM products");
20    $stmt->execute();
21
22    // PDO::FETCH_COLUMN を指定すると、SELECT文で指定した単一のカラムの値が
23    // 結果セットから抽出され、配列の要素として全て取得されます。
24    $productNames = $stmt->fetchAll(PDO::FETCH_COLUMN);
25
26    echo "取得した商品名:\n";
27    print_r($productNames); // 例: [ 'Laptop', 'Mouse', 'Keyboard' ]
28
29    echo "\n--- 商品価格（priceカラム）だけをリストとして取得 ---\n";
30    $stmt = $pdo->prepare("SELECT price FROM products");
31    $stmt->execute();
32    $productPrices = $stmt->fetchAll(PDO::FETCH_COLUMN);
33
34    echo "取得した商品価格:\n";
35    print_r($productPrices); // 例: [ 1200.0, 25.5, 75.0 ]
36
37    echo "\n--- 複数カラムを選択した場合の PDO::FETCH_COLUMN の挙動（最初のカラムのみ取得） ---\n";
38    $stmt = $pdo->prepare("SELECT id, name, price FROM products");
39    $stmt->execute();
40    // SELECT文で複数のカラムを指定した場合でも、PDO::FETCH_COLUMN はデフォルトで
41    // 最初のカラムの値のみを取得します。
42    $idsOnly = $stmt->fetchAll(PDO::FETCH_COLUMN);
43
44    echo "SELECT id, name, price を指定し、PDO::FETCH_COLUMN で取得した値（'id' カラムのみ）:\n";
45    print_r($idsOnly); // 例: [ 1, 2, 3 ]
46
47} catch (PDOException $e) {
48    // データベース接続やクエリ実行時に発生したエラーをキャッチして表示
49    echo "データベース操作中にエラーが発生しました: " . $e->getMessage();
50}
51

PHPのPDO::FETCH_COLUMNは、PHP 8のPDO拡張機能に含まれる定数です。これは、データベースから取得したクエリ結果（結果セット）を、PHPの配列としてどのように整形するかを指示する「フェッチモード」の一つとして利用されます。この定数の主な役割は、SQLのSELECT文で取得したデータのうち、特定の単一カラムの値のみを抽出し、その値で構成されるシンプルな一次元配列として取得することです。

PDO::FETCH_COLUMNは、主にPDOStatementクラスのfetchAll()メソッドの引数として渡して使用します。例えば、データベースから商品名だけをリストとして取得したい場合、SELECT name FROM productsのようなクエリを実行し、$stmt->fetchAll(PDO::FETCH_COLUMN)と指定することで、すべての商品名が格納された配列を得られます。

重要な点として、もしSELECT文でSELECT id, name, price FROM productsのように複数のカラムを指定した場合でも、PDO::FETCH_COLUMNはデフォルトで最初に指定されたカラム（この例ではidカラム）の値のみを配列として抽出します。PDO::FETCH_COLUMN定数自体は引数を持ちませんが、fetchAll()などのメソッドに渡すことで、そのメソッドが返す配列の形式と内容を制御するという役割を果たします。これにより、データベースからのデータ取得において、特定の情報だけを効率的に抽出して活用することが可能になります。

Copy
1<?php
2
3/**
4 * PDO::FETCH_COLUMN 定数を使用して、データベースから特定のカラムの値のみを取得するサンプルコードです。
5 *
6 * この定数は、PDOStatement::fetch() や PDOStatement::fetchAll() メソッドの
7 * フェッチスタイルとして使用され、結果セットから指定された列の値を返します。
8 * 主に、単一のカラムのリスト（配列）を取得したい場合に便利です。
9 */
10function demonstratePdoFetchColumn(): void
11{
12    // SQLiteのインメモリデータベースに接続します。
13    // 本番環境では、'mysql:host=localhost;dbname=testdb', 'user', 'password' のように
14    // 適切なDSN、ユーザー名、パスワードを設定してください。
15    $dsn = 'sqlite::memory:';
16    $username = null; // SQLiteインメモリDBでは通常不要
17    $password = null; // SQLiteインメモリDBでは通常不要
18
19    try {
20        $pdo = new PDO($dsn, $username, $password);
21        // PDOのエラーモードを例外(PDOException)をスローするように設定します。
22        // これにより、SQLエラーが発生した場合にキャッチして適切に処理できます。
23        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
24
25        echo "データベース接続に成功しました。\n";
26
27        // 1. テスト用のusersテーブルを作成します。
28        $pdo->exec("
29            CREATE TABLE IF NOT EXISTS users (
30                id INTEGER PRIMARY KEY AUTOINCREMENT,
31                name TEXT NOT NULL,
32                email TEXT NOT NULL
33            );
34        ");
35        echo "テーブル 'users' を作成しました。\n";
36
37        // 2. テストデータを挿入します。
38        $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com');");
39        $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com');");
40        $pdo->exec("INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com');");
41        echo "テストデータを挿入しました。\n";
42
43        // 3. PDO::FETCH_COLUMN を使用して、全てのユーザー名を取得します。
44        // SELECT id, name, email FROM users の結果において、
45        // 'name' カラムは0から始まるインデックスで2番目（インデックス1）です。
46        echo "\n--- 全てのユーザー名を取得 (PDO::FETCH_COLUMN, インデックス 1) ---\n";
47        $stmt = $pdo->query("SELECT id, name, email FROM users");
48        $names = $stmt->fetchAll(PDO::FETCH_COLUMN, 1);
49
50        foreach ($names as $name) {
51            echo "名前: " . $name . "\n";
52        }
53
54        // 4. PDO::FETCH_COLUMN を使用して、全てのユーザーIDを取得します。
55        // 'id' カラムは0から始まるインデックスで1番目（インデックス0）です。
56        echo "\n--- 全てのユーザーIDを取得 (PDO::FETCH_COLUMN, インデックス 0) ---\n";
57        $stmt = $pdo->query("SELECT id, name, email FROM users");
58        $ids = $stmt->fetchAll(PDO::FETCH_COLUMN, 0);
59
60        foreach ($ids as $id) {
61            echo "ID: " . $id . "\n";
62        }
63
64    } catch (PDOException $e) {
65        // データベース関連のエラーが発生した場合に処理します。
66        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
67    } finally {
68        // PDOオブジェクトはスクリプト終了時に自動的にクローズされますが、
69        // 明示的にnullを設定することで、接続を解放するタイミングを制御できます。
70        $pdo = null;
71        echo "\nデータベース接続を閉じました。\n";
72    }
73}
74
75// 関数を実行して、サンプルコードの動作を確認します。
76demonstratePdoFetchColumn();

PHPのPDO::FETCH_COLUMNは、データベースからのクエリ結果において、特定の1カラムの値だけを効率的に配列として取得するための定数です。この定数は、PDOStatement::fetch()やPDOStatement::fetchAll()メソッドのフェッチスタイルとして使用され、結果セットから指定された列の値を返します。主に、データベースから単一の列のリスト、例えば全てのユーザー名や商品IDの配列などを取得したい場合に非常に便利です。

提供されたサンプルコードでは、まずSQLiteのインメモリデータベースに接続し、usersテーブルを作成してテストデータを挿入しています。その後、SELECT id, name, email FROM usersというSQLクエリを実行し、その結果から特定のカラムの値だけを取得するデモンストレーションを行っています。

PDO::FETCH_COLUMN自体には引数や戻り値はありませんが、fetchAll()メソッドの第二引数として列のインデックス（0から始まる番号）を指定することで、どのカラムのデータを取得するかを指示します。例えば、$stmt->fetchAll(PDO::FETCH_COLUMN, 1)と記述すると、結果セットの2番目のカラム（インデックス1）に該当するnameカラムのすべての値が配列として返されます。同様に、第二引数に0を指定すれば、1番目のカラム（インデックス0）であるidカラムの全ての値を取得できます。このように、PDO::FETCH_COLUMNを使用することで、必要なデータだけを簡潔に配列形式で扱えるようになります。