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

Copy
1<?php
2
3/**
4 * SQLiteデータベースからデータをPDO::FETCH_NUMスタイルで取得し、取得した行数をカウントして返します。
5 *
6 * PDO::FETCH_NUM は、結果セットの各行を0から始まる数値インデックスを持つ配列として返します。
7 * このサンプルでは、実際にフェッチした行の数を数える方法を示します。
8 *
9 * @return int 取得した行数、またはエラーの場合は-1
10 */
11function getRowsCountWithFetchNum(): int
12{
13    // SQLiteデータベースファイルのパス
14    $dbFile = 'mydatabase.sqlite';
15    // DSN (Data Source Name)
16    $dsn = "sqlite:$dbFile";
17
18    try {
19        // 1. SQLiteデータベースに接続
20        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定し、データベースエラー時に例外をスローさせます。
21        $pdo = new PDO($dsn, null, null, [
22            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
23        ]);
24
25        // 2. テスト用のテーブルを作成（もし存在しなければ）
26        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
27            id INTEGER PRIMARY KEY AUTOINCREMENT,
28            name TEXT NOT NULL,
29            email TEXT NOT NULL UNIQUE
30        )");
31
32        // 3. テスト用のデータを挿入（既に同じメールアドレスがあれば挿入しない）
33        $pdo->exec("INSERT OR IGNORE INTO users (name, email) VALUES ('Alice', 'alice@example.com')");
34        $pdo->exec("INSERT OR IGNORE INTO users (name, email) VALUES ('Bob', 'bob@example.com')");
35        $pdo->exec("INSERT OR IGNORE INTO users (name, email) VALUES ('Charlie', 'charlie@example.com')");
36
37        // 4. データを選択し、PDO::FETCH_NUM スタイルでフェッチ
38        $stmt = $pdo->query("SELECT id, name, email FROM users");
39
40        $fetchedRowsCount = 0;
41        echo "--- PDO::FETCH_NUM スタイルでデータを取得 ---" . PHP_EOL;
42
43        // ループで一行ずつデータをフェッチし、行数をカウント
44        while ($row = $stmt->fetch(PDO::FETCH_NUM)) {
45            // $row は、例えば ['1', 'Alice', 'alice@example.com'] のように
46            // 数値インデックスを持つ配列としてデータが取得されます。
47            echo "ID: " . $row[0] . ", Name: " . $row[1] . ", Email: " . $row[2] . PHP_EOL;
48            $fetchedRowsCount++;
49        }
50        echo "------------------------------------" . PHP_EOL;
51
52        // 5. フェッチした行数を返します
53        return $fetchedRowsCount;
54
55    } catch (PDOException $e) {
56        // データベース接続やクエリ実行中のエラーをキャッチ
57        echo "データベースエラーが発生しました: " . $e->getMessage() . PHP_EOL;
58        return -1; // エラーを示す値として-1を返す
59    } finally {
60        // データベース接続はスクリプト終了時やPDOオブジェクトがスコープ外に出たときに自動的に閉じられますが、
61        // 必要であれば明示的に $pdo = null; と設定することも可能です。
62        
63        // テスト用に作成したデータベースファイルを削除したい場合は、以下のコメントアウトを外してください。
64        // if (file_exists($dbFile)) {
65        //     unlink($dbFile);
66        // }
67    }
68}
69
70// 関数の実行と結果の表示
71$totalFetchedRows = getRowsCountWithFetchNum();
72
73if ($totalFetchedRows >= 0) {
74    echo "実際にフェッチされた総行数: " . $totalFetchedRows . "行" . PHP_EOL;
75}
76
77?>

このPHPサンプルコードは、PDO（PHP Data Objects）という機能を使ってデータベースからデータを取得する際に用いられる PDO::FETCH_NUM 定数の使い方を、システムエンジニアを目指す初心者向けに解説しています。

PDO::FETCH_NUM は、データベースからデータを「フェッチ」（取得）する際のデータの形式を指定する定数です。これを使用すると、取得したデータベースの各行が、0から始まる数値インデックスを持つ配列として返されます。例えば、結果の最初のカラムには $row[0]、次のカラムには $row[1] のようにアクセスできます。

サンプルコードでは、まずSQLiteデータベースへの接続を確立し、テスト用のテーブルとデータを準備しています。その後、SELECT 文でデータを取得し、$stmt->fetch(PDO::FETCH_NUM) メソッドを使って一行ずつデータをフェッチしています。ループ内でデータを取得するごとにカウンターを増やし、最終的に取得できた行の総数を数えて返します。この関数自体には引数がありませんが、正常に実行されれば取得できた行数を示す整数が、データベースエラーが発生した場合には-1が戻り値として返されます。この方法は、データを順番に処理しながら、実際に何行のデータが取得されたかを正確に把握したい場合に役立ちます。

Copy
1<?php
2
3/**
4 * PDO::FETCH_NUM 定数を使用してデータベースからデータを取得する方法を示す関数です。
5 * PDO::FETCH_NUM は、結果セットを行番号をキーとする配列として取得します。
6 * システムエンジニアを目指す初心者向けに、SQLiteインメモリデータベースを使用した基本的な例です。
7 */
8function demonstratePdoFetchNum(): void
9{
10    // データベース接続情報（SQLiteのインメモリデータベースを使用）
11    // メモリ上に一時的なデータベースを作成するため、ファイルは作成されません。
12    $dsn = 'sqlite::memory:';
13
14    try {
15        // 1. PDOインスタンスの作成
16        // データベースへの接続を確立します。
17        $pdo = new PDO($dsn);
18
19        // 2. エラーモードの設定
20        // PDO::ERRMODE_EXCEPTION を設定することで、エラーが発生した際にPDOExceptionをスローします。
21        // これにより、try-catchブロックでエラーを捕捉しやすくなります。
22        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
23
24        echo "データベースに接続しました。\n";
25
26        // 3. テーブルの作成
27        // SQLクエリを実行して、'users' テーブルを作成します。
28        $pdo->exec("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)");
29        echo "テーブル 'users' を作成しました。\n";
30
31        // 4. データの挿入
32        // 作成したテーブルにサンプルデータを挿入します。
33        $pdo->exec("INSERT INTO users (name, email) VALUES ('山田太郎', 'yamada@example.com')");
34        $pdo->exec("INSERT INTO users (name, email) VALUES ('鈴木花子', 'suzuki@example.com')");
35        echo "データを挿入しました。\n";
36
37        // 5. PDO::FETCH_NUM を使用してデータを取得
38        // SELECTクエリを実行し、PDOStatementオブジェクトを取得します。
39        $stmt = $pdo->query("SELECT id, name, email FROM users");
40
41        // fetchAll() メソッドに PDO::FETCH_NUM を指定することで、
42        // 結果セットの各行が行番号をキーとする配列として取得されます。
43        // 例: [0 => 1, 1 => '山田太郎', 2 => 'yamada@example.com']
44        $rows = $stmt->fetchAll(PDO::FETCH_NUM);
45
46        echo "\n--- PDO::FETCH_NUM で取得したデータ ---\n";
47        // 取得したデータをループで表示します。
48        foreach ($rows as $row) {
49            // 各$rowは数値インデックスの配列です。
50            echo "ID: " . $row[0] . ", 名前: " . $row[1] . ", メール: " . $row[2] . "\n";
51        }
52        echo "-------------------------------------\n";
53
54    } catch (PDOException $e) {
55        // データベース接続や操作でエラーが発生した場合に、例外を捕捉してメッセージを表示します。
56        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
57    } catch (Exception $e) {
58        // その他の予期せぬエラーが発生した場合に、例外を捕捉してメッセージを表示します。
59        echo "一般的なエラーが発生しました: " . $e->getMessage() . "\n";
60    }
61}
62
63// 関数を実行して、PDO::FETCH_NUM の動作を確認します。
64demonstratePdoFetchNum();

PDO::FETCH_NUMは、PHPでデータベースを操作するPDO（PHP Data Objects）拡張機能において、データベースからデータを取得する際の「フェッチモード」を指定するための定数です。この定数自体には引数はなく、内部的には整数値として定義されています。

この定数を指定してデータベースからデータを取得すると、結果セットの各行が、カラムの並び順に応じた「数値インデックス（行番号）」をキーとする配列として返されます。例えば、SELECT id, name FROM usersというクエリで取得した行は、[0 => 1, 1 => '山田太郎']のような形式になります。

提供されたサンプルコードでは、まずSQLiteのインメモリデータベースに接続し、usersテーブルを作成してサンプルデータを挿入しています。その後、SELECTクエリを実行してPDOStatementオブジェクトを取得し、fetchAll()メソッドにPDO::FETCH_NUMを引数として渡すことで、データを数値インデックス配列として一括取得しています。ループ処理で各行を表示する際には、$row[0]、$row[1]のように数値インデックスを用いてカラムの値にアクセスしている点が特徴です。これにより、取得したデータの各項目を、その並び順に基づいて簡潔に扱うことができます。データベース操作の基本的な取得方法の一つとして、システム開発で広く利用されます。