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

Copy
1<?php
2
3/**
4 * PDO_SQLITEとPDO::FETCH_OBJ、PDO::FETCH_ORI_RELの使用例。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * SQLiteデータベースの操作、スクロール可能なカーソルの有効化、
8 * そしてPDO::FETCH_OBJとPDO::FETCH_ORI_REL定数を使ったデータの取得方法を示します。
9 *
10 * PDO::FETCH_OBJ: 結果セットの行を匿名オブジェクトとしてフェッチします。
11 *                 オブジェクトのプロパティ名は、カラム名に対応します。
12 * PDO::FETCH_ORI_REL: PDOStatement::fetch()メソッドで、現在のカーソル位置から
13 *                     指定されたオフセットだけ相対的に移動して行を取得します。
14 *                     この定数を使用するには、PDO接続時にPDO::ATTR_CURSORを
15 *                     PDO::CURSOR_SCROLLに設定する必要があります。
16 */
17function demonstratePdoSqliteFetchObjectWithRelativeOrientation(): void
18{
19    // SQLiteデータベースファイルのパスを定義
20    $dbFile = 'sample_users.sqlite';
21
22    try {
23        // 既存のデータベースファイルを削除（単体動作とクリーンアップのため）
24        if (file_exists($dbFile)) {
25            unlink($dbFile);
26        }
27
28        // PDO接続オプションを設定
29        $options = [
30            // エラー発生時に例外をスローするモードを設定
31            PDO::ATTR_ERRMODE    => PDO::ERRMODE_EXCEPTION,
32            // スクロール可能なカーソルを有効にする（FETCH_ORI_RELで必須）
33            PDO::ATTR_CURSOR     => PDO::CURSOR_SCROLL,
34        ];
35
36        // SQLiteデータベースに接続
37        // "sqlite:$dbFile" はSQLiteデータベースへのDSN (Data Source Name)
38        $pdo = new PDO("sqlite:$dbFile", null, null, $options);
39        echo "SQLiteデータベースに接続しました: $dbFile\n";
40
41        // usersテーブルを作成（もし存在しなければ）
42        $pdo->exec(
43            "CREATE TABLE IF NOT EXISTS users (
44                id INTEGER PRIMARY KEY AUTOINCREMENT,
45                name TEXT NOT NULL,
46                email TEXT NOT NULL UNIQUE
47            );"
48        );
49        echo "テーブル 'users' を作成しました。\n";
50
51        // サンプルデータを挿入
52        $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com');");
53        $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com');");
54        $pdo->exec("INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com');");
55        echo "サンプルデータを挿入しました。\n";
56
57        // usersテーブルから全件データを取得するクエリを実行
58        // ORDER BY id で結果の順序を保証
59        $stmt = $pdo->query("SELECT id, name, email FROM users ORDER BY id ASC;");
60        echo "SELECTクエリを実行しました。\n";
61
62        echo "\n--- PDO::FETCH_OBJ と PDO::FETCH_ORI_REL の使用例 ---\n";
63
64        // 1. 最初の行をオブジェクトとして取得 (PDO::FETCH_ORI_NEXTを使用)
65        // PDO::FETCH_ORI_NEXT はカーソルを次の行に進めます。
66        $user1 = $stmt->fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_NEXT);
67        if ($user1) {
68            echo "1. 最初のユーザー (FETCH_ORI_NEXT):\n";
69            echo "   ID: {$user1->id}, 名前: {$user1->name}, メール: {$user1->email}\n";
70        }
71
72        // 2. 現在のカーソル位置から相対的に1つ先の行をオブジェクトとして取得 (PDO::FETCH_ORI_RELを使用)
73        // PDO::FETCH_ORI_REL を指定し、オフセット 1 で現在のカーソル位置から1つ後の行を取得します。
74        $user2 = $stmt->fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_REL, 1);
75        if ($user2) {
76            echo "2. 相対的に次のユーザー (FETCH_ORI_REL, オフセット 1):\n";
77            echo "   ID: {$user2->id}, 名前: {$user2->name}, メール: {$user2->email}\n";
78        }
79
80        // 3. 現在のカーソル位置から相対的に1つ前の行をオブジェクトとして取得 (PDO::FETCH_ORI_RELを使用)
81        // PDO::FETCH_ORI_REL を指定し、オフセット -1 で現在のカーソル位置から1つ前の行を取得します。
82        $user3 = $stmt->fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_REL, -1);
83        if ($user3) {
84            echo "3. 相対的に前のユーザー (FETCH_ORI_REL, オフセット -1):\n";
85            echo "   ID: {$user3->id}, 名前: {$user3->name}, メール: {$user3->email}\n";
86        }
87
88        // 結果セットを解放し、カーソルを閉じます
89        $stmt->closeCursor();
90
91    } catch (PDOException $e) {
92        // データベース関連のエラーを捕捉し、エラーメッセージを表示
93        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
94    } catch (Exception $e) {
95        // その他の予期せぬエラーを捕捉し、エラーメッセージを表示
96        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
97    } finally {
98        // 処理の終了をユーザーに通知
99        echo "\n処理が完了しました。\n";
100        // デモンストレーションのため、データベースファイルは残します。
101        // 自動的に削除したい場合は、以下のコメントアウトを解除してください。
102        // if (file_exists($dbFile)) {
103        //     unlink($dbFile);
104        //     echo "データベースファイル '$dbFile' を削除しました。\n";
105        // }
106    }
107}
108
109// 関数を実行してデモンストレーションを開始
110demonstratePdoSqliteFetchObjectWithRelativeOrientation();

このサンプルコードは、PHPを使ってSQLiteデータベースを操作し、データを柔軟に取得する方法をシステムエンジニアを目指す初心者向けに解説しています。特に、データベースからのデータ取得形式をオブジェクトにするPDO::FETCH_OBJと、結果セットのカーソルを相対的に移動させてデータを取得するPDO::FETCH_ORI_REL定数の使い方を示しています。

PDO::FETCH_OBJは、データベースの各行を匿名のオブジェクトとして取得する際に使用します。取得されたオブジェクトのプロパティ名には、データベースのカラム名がそのまま適用されるため、$user->nameのように直感的にデータにアクセスできます。

PDO::FETCH_ORI_RELは、PDOStatement::fetch()メソッドでデータを取得する際、現在のカーソル位置から指定されたオフセット（相対的な位置）で前後の行を取得するために使う定数です。この機能を利用するには、PDO接続時にPDO::ATTR_CURSORオプションをPDO::CURSOR_SCROLLに設定し、スクロール可能なカーソルを有効にする必要があります。PDO::FETCH_ORI_REL自体は引数を取らず、内部的に整数値として機能し、fetch()メソッドの第3引数と組み合わせてカーソル移動方向と量を指定します。

コードでは、まずSQLiteデータベースを作成してサンプルデータを挿入しています。その後、SELECTクエリを実行して結果セットを取得し、$stmt->fetch()メソッドにPDO::FETCH_OBJと、カーソル移動を指定する定数を渡してデータを取得しています。具体的には、PDO::FETCH_ORI_NEXTで最初の行を、PDO::FETCH_ORI_REL, 1で次の行を、そしてPDO::FETCH_ORI_REL, -1で前の行を、それぞれオブジェクトとして取得し、その内容を表示しています。これにより、結果セット内を自由に移動しながらデータを柔軟に取得できる点が特徴です。

Copy
1<?php
2
3/**
4 * PDO::FETCH_ORI_REL 定数の使用例を示す関数。
5 * SQLiteデータベースを使用し、結果セットの相対的な位置からデータをフェッチします。
6 *
7 * システムエンジニアを目指す初心者向けに、`fetchone` (単一行の取得) の概念と、
8 * `FETCH_ORI_REL` を使ったカーソル移動を組み合わせたデータ取得方法を説明します。
9 */
10function demonstratePdoFetch(): void
11{
12    // データベース接続設定
13    // `sqlite::memory:` はメモリ上に一時的なデータベースを作成します。
14    // PDO::ATTR_ERRMODE を設定することで、データベースエラーを例外として捕捉しやすくなります。
15    // PDO::ATTR_DEFAULT_FETCH_MODE を設定することで、デフォルトのフェッチ形式を連想配列にします。
16    // PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL は、PDO::FETCH_ORI_REL を使用するために必須です。
17    $dsn = 'sqlite::memory:';
18    $options = [
19        PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
20        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
21        PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL,
22    ];
23
24    try {
25        // データベースに接続
26        $pdo = new PDO($dsn, null, null, $options);
27        echo "データベース接続成功。\n\n";
28
29        // テスト用のテーブルを作成
30        $pdo->exec("
31            CREATE TABLE IF NOT EXISTS products (
32                id INTEGER PRIMARY KEY,
33                name TEXT NOT NULL,
34                price INTEGER NOT NULL
35            );
36        ");
37        echo "テーブル 'products' を作成しました。\n";
38
39        // データを挿入
40        $pdo->exec("INSERT INTO products (name, price) VALUES ('Apple', 100)");
41        $pdo->exec("INSERT INTO products (name, price) VALUES ('Banana', 50)");
42        $pdo->exec("INSERT INTO products (name, price) VALUES ('Orange', 80)");
43        echo "3件のデータを挿入しました。\n\n";
44
45        // --- クエリ実行とデータフェッチ ---
46
47        // SELECT文を実行し、PDOStatementオブジェクトを取得
48        $stmt = $pdo->query("SELECT id, name, price FROM products ORDER BY id");
49        echo "製品データを取得するクエリを実行しました。\n";
50
51        // 1. 基本的な `fetchone` (単一行の取得) の例
52        // PDOStatement::fetch() はデフォルトで次の1行をフェッチします。
53        // これがPythonなどのDB APIにおける `fetchone` に相当します。
54        $product1 = $stmt->fetch();
55        if ($product1) {
56            echo "--- 基本的な `fetchone` (1行目) ---\n";
57            echo "ID: " . $product1['id'] . ", 名前: " . $product1['name'] . ", 価格: " . $product1['price'] . "\n\n";
58        } else {
59            echo "1行目のデータが見つかりませんでした。\n\n";
60        }
61
62        // 2. PDO::FETCH_ORI_REL を使った相対的なフェッチの例
63        // `PDO::FETCH_ORI_REL` は、現在のカーソル位置から指定されたオフセットで移動してフェッチします。
64        // 上の `fetch()` でカーソルは既に2行目の手前に移動しています。
65        // `PDO::FETCH_ORI_REL, 1` は現在の位置から1つ次の行（この場合、リストの2番目のデータ）をフェッチします。
66        $product2 = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_REL, 1);
67        if ($product2) {
68            echo "--- `PDO::FETCH_ORI_REL` を使ったフェッチ (現在の位置から+1行, 2行目) ---\n";
69            echo "ID: " . $product2['id'] . ", 名前: " . $product2['name'] . ", 価格: " . $product2['price'] . "\n\n";
70        } else {
71            echo "2行目のデータが見つかりませんでした。\n\n";
72        }
73
74        // 3. もう一度 PDO::FETCH_ORI_REL を使い、前の行に戻る例
75        // 現在カーソルは3行目の手前にあります。（2行目のデータを取得した後）
76        // `PDO::FETCH_ORI_REL, -1` は現在の位置から1つ前の行（つまり2行目）をフェッチします。
77        $product2Again = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_REL, -1);
78        if ($product2Again) {
79            echo "--- `PDO::FETCH_ORI_REL` を使ったフェッチ (現在の位置から-1行, 2行目) ---\n";
80            echo "ID: " . $product2Again['id'] . ", 名前: " . $product2Again['name'] . ", 価格: " . $product2Again['price'] . "\n\n";
81        } else {
82            echo "データが見つかりませんでした。（カーソル位置を確認してください）\n\n";
83        }
84
85    } catch (PDOException $e) {
86        // PDO関連のエラーを捕捉し、エラーメッセージを表示
87        echo "データベースエラー: " . $e->getMessage() . "\n";
88    } catch (Exception $e) {
89        // その他の一般的なエラーを捕捉し、エラーメッセージを表示
90        echo "一般的なエラー: " . $e->getMessage() . "\n";
91    } finally {
92        // データベース接続を閉じる (PDOオブジェクトにnullを代入することでPHPのガベージコレクションによって閉じられます)
93        $pdo = null;
94        echo "データベース接続を閉じました。\n";
95    }
96}
97
98// 関数を実行
99demonstratePdoFetch();

このサンプルコードは、PHPのPDO拡張で提供されるPDO::FETCH_ORI_REL定数の使用方法を説明しています。この定数は、データベースのクエリ結果（結果セット）の中から、現在のカーソル位置を基準にして、指定されたオフセット（相対的な位置）のデータを取得する際に使用します。この機能を使うには、PDOのデータベース接続時にPDO::ATTR_CURSORオプションをPDO::CURSOR_SCROLLに設定する必要があります。

コードでは、まずメモリ上に一時的なSQLiteデータベースを作成し、テストデータを挿入します。次に、PDOStatement::fetch()メソッドを用いてデータを単一行ずつ取得する基本的な方法を示します。これは、他のプログラミング言語におけるfetchoneの概念に相当します。

その後、PDO::FETCH_ORI_REL定数とオフセット値（例えば1で次の行、-1で前の行）を組み合わせてfetch()メソッドに渡すことで、現在のカーソル位置から相対的に前方や後方へ移動し、必要なデータを柔軟に取得できることを実演しています。これにより、結果セット内を自由に移動してデータを取得する操作が可能になります。

PDO::FETCH_ORI_REL定数自体に引数はなく、内部的にカーソル移動の種類を表す整数値を持ちます。