【PHP8.x】Pdo\Sqlite::FETCH_KEY_PAIR定数の使い方

Copy
1<?php
2
3/**
4 * PDO::FETCH_KEY_PAIR を使用してデータベースからキーと値のペアを取得する例を示します。
5 * この関数は、システムエンジニアを目指す初心者向けに、
6 * PDOの基本的な使い方と FETCH_KEY_PAIR 定数の動作を簡潔に示します。
7 */
8function demonstratePdoFetchKeyPair(): void
9{
10    // SQLite インメモリデータベースを使用します。
11    // これはファイルを作成せず、スクリプト実行中にメモリ上に一時的なデータベースを作成します。
12    $dsn = 'sqlite::memory:';
13
14    try {
15        // 1. PDO (PHP Data Objects) オブジェクトを作成し、データベースに接続します。
16        // エラー発生時に例外をスローするように設定し、堅牢なコードにします。
17        $pdo = new PDO($dsn);
18        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
19
20        echo "データベースに接続しました。\n";
21
22        // 2. テスト用のテーブルを作成します。
23        // 'config' というテーブルに 'key' と 'value' の2つのカラムを用意します。
24        $pdo->exec("
25            CREATE TABLE IF NOT EXISTS config (
26                key TEXT PRIMARY KEY,
27                value TEXT NOT NULL
28            );
29        ");
30        echo "テーブル 'config' を作成しました。\n";
31
32        // 3. サンプルデータをテーブルに挿入します。
33        $pdo->exec("INSERT INTO config (key, value) VALUES ('app_name', 'My PHP Application');");
34        $pdo->exec("INSERT INTO config (key, value) VALUES ('version', '1.0.0');");
35        $pdo->exec("INSERT INTO config (key, value) VALUES ('environment', 'development');");
36        echo "サンプルデータを挿入しました。\n";
37
38        // 4. PDO::FETCH_KEY_PAIR モードを使用してデータを取得します。
39        // SELECT文で選択される最初のカラムが結果のキーとなり、2番目のカラムが値となります。
40        $stmt = $pdo->query("SELECT key, value FROM config");
41
42        // fetchAll() メソッドに PDO::FETCH_KEY_PAIR 定数を渡すことで、
43        // データベースからキーと値のペアの連想配列として結果を取得します。
44        // FETCH_KEY_PAIR は PDO クラスの定数として利用されます。
45        $configData = $stmt->fetchAll(PDO::FETCH_KEY_PAIR);
46
47        echo "\n--- FETCH_KEY_PAIR で取得したデータ ---\n";
48        // 5. 取得した結果を表示します。
49        foreach ($configData as $key => $value) {
50            echo "Key: " . $key . ", Value: " . $value . "\n";
51        }
52        echo "--------------------------------------\n";
53
54        echo "\nPDO::FETCH_KEY_PAIR は、データベースの最初のカラムをキー、2番目のカラムを値とする連想配列を効率的に作成する際に非常に便利です。\n";
55
56    } catch (PDOException $e) {
57        // 6. データベース操作中にエラーが発生した場合、ここで捕捉してメッセージを表示します。
58        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
59    } finally {
60        // データベース接続をクローズします。
61        // PHPではスクリプト終了時に自動的に閉じられますが、明示的に null を設定することも一般的です。
62        $pdo = null;
63        echo "データベース接続を閉じました。\n";
64    }
65}
66
67// 関数を実行します。
68demonstratePdoFetchKeyPair();

PHPのPDO::FETCH_KEY_PAIRは、PHP Data Objects (PDO) 拡張機能を使用してデータベースからデータを取得する際に、結果の形式を指定するための定数です。この定数自体に引数や戻り値はありませんが、PDOStatementオブジェクトのfetchAll()などのメソッドの引数として渡すことで、データ取得結果の形式を制御します。

PDO::FETCH_KEY_PAIRを指定してデータを取得すると、SQLのSELECT文で選択された最初のカラムの値が結果の連想配列のキーとなり、2番目のカラムの値がそのキーに対応する値としてマッピングされます。これにより、例えばデータベースに保存された設定情報など、「キー」と「値」のペアで構成されるデータを、PHPの連想配列として直感的かつ効率的に取得できます。システムエンジニアを目指す初心者の方にとって、データベースから特定のキーと値の形式でデータを簡単に取り出し、コード内で利用する際に非常に役立つ便利な機能です。特に、設定管理やマッピングデータの読み込みなど、キーバリュー形式のデータを扱う場面でその利便性を実感できるでしょう。