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

Copy
1<?php
2
3/**
4 * PDO::CURSOR_SCROLL を使用したスクロール可能なカーソルのデモンストレーション。
5 * データベースの結果セット内を前後に移動する方法を示します。
6 * システムエンジニアを目指す初心者向けに、PDOの基本的なカーソル操作を解説します。
7 */
8function demonstrateScrollableCursor(): void
9{
10    // SQLiteのインメモリデータベースを使用するため、外部ファイルや複雑な設定は不要です。
11    $dsn = 'sqlite::memory:';
12    $options = [
13        PDO::ATTR_ERRMODE          => PDO::ERRMODE_EXCEPTION, // エラー発生時に例外をスローする設定
14        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,     // デフォルトのフェッチモードを連想配列に設定
15        PDO::ATTR_CURSOR           => PDO::CURSOR_SCROLL,     // スクロール可能なカーソルを有効にする設定
16    ];
17
18    try {
19        // データベースに接続
20        $pdo = new PDO($dsn, null, null, $options);
21        echo "データベースに接続しました。\n";
22
23        // サンプルテーブルを作成し、データを挿入
24        $pdo->exec("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)");
25        $pdo->exec("INSERT INTO users (name) VALUES ('Alice'), ('Bob'), ('Charlie'), ('David')");
26        echo "サンプルデータでusersテーブルを準備しました。\n";
27
28        // スクロール可能なカーソルでデータを取得するためのプリペアドステートメントを準備
29        $stmt = $pdo->prepare("SELECT id, name FROM users ORDER BY id");
30        $stmt->execute();
31        echo "クエリを実行し、結果セットを取得しました。\n";
32
33        echo "\n--- カーソル操作のデモンストレーション ---\n";
34
35        // 1. 最初の行を取得 (PDO::FETCH_ORI_NEXT は次の行へ移動)
36        $row1 = $stmt->fetch(PDO::FETCH_ORI_NEXT);
37        if ($row1) {
38            echo "1. 最初の行を取得: ID=" . $row1['id'] . ", Name=" . $row1['name'] . "\n";
39        }
40
41        // 2. 次の行を取得
42        $row2 = $stmt->fetch(PDO::FETCH_ORI_NEXT);
43        if ($row2) {
44            echo "2. 次の行を取得: ID=" . $row2['id'] . ", Name=" . $row2['name'] . "\n";
45        }
46
47        // 3. 前の行に戻る (PDO::CURSOR_SCROLL を設定しているため可能)
48        $rowPrev = $stmt->fetch(PDO::FETCH_ORI_PRIOR);
49        if ($rowPrev) {
50            echo "3. 前の行に戻る: ID=" . $rowPrev['id'] . ", Name=" . $rowPrev['name'] . "\n";
51        }
52
53        // 4. 3番目の行に直接ジャンプ (絶対位置、インデックスは0から始まるためオフセットは2)
54        $rowAbs = $stmt->fetch(PDO::FETCH_ORI_ABS, 2);
55        if ($rowAbs) {
56            echo "4. 3番目の行にジャンプ: ID=" . $rowAbs['id'] . ", Name=" . $rowAbs['name'] . "\n";
57        }
58
59        // 5. 現在位置から相対的に移動 (例: 1つ前に戻る)
60        $rowRel = $stmt->fetch(PDO::FETCH_ORI_REL, -1);
61        if ($rowRel) {
62            echo "5. 現在位置から1つ前に移動: ID=" . $rowRel['id'] . ", Name=" . $rowRel['name'] . "\n";
63        }
64
65        echo "\n--- 残りの行を順に取得して終了 ---\n";
66        // 現在位置から最後まで順次取得
67        while ($row = $stmt->fetch(PDO::FETCH_ORI_NEXT)) {
68            echo "残り: ID=" . $row['id'] . ", Name=" . $row['name'] . "\n";
69        }
70
71    } catch (PDOException $e) {
72        // データベース関連のエラーをキャッチ
73        echo "データベースエラー: " . $e->getMessage() . "\n";
74    } catch (Exception $e) {
75        // その他の予期せぬエラーをキャッチ
76        echo "予期せぬエラー: " . $e->getMessage() . "\n";
77    } finally {
78        // データベース接続を閉じる (PDOオブジェクトがスコープを外れると自動的に閉じられますが、明示的にnullを代入することもできます)
79        $pdo = null;
80        echo "\nデータベース接続を閉じました。\n";
81    }
82}
83
84// 関数を実行し、カーソル操作のデモンストレーションを開始
85demonstrateScrollableCursor();
86

PHPのPDO::CURSOR_SCROLLは、データベースから取得した結果セット内を自由に移動できる「スクロール可能なカーソル」を有効にするための定数です。通常、データベースからデータを取得する際は、次の行へしか進めない「順方向のみのカーソル」が使われますが、この定数をPDO接続時のオプションとして設定することで、結果セット内の行を前後に移動したり、特定の位置に直接ジャンプしたりできるようになります。

この定数は引数を持たず、内部的に整数値を返します。サンプルコードでは、PDOオブジェクトの初期化時にオプション配列のPDO::ATTR_CURSORキーにPDO::CURSOR_SCROLLを指定しています。これにより、$stmt->fetch()メソッドにPDO::FETCH_ORI_NEXT（次へ）、PDO::FETCH_ORI_PRIOR（前へ）、PDO::FETCH_ORI_ABS（絶対位置へ）、PDO::FETCH_ORI_REL（相対位置へ）といった定数を組み合わせることで、結果セット内を柔軟に操作できることを示しています。一度読み進んだ行に再度戻って処理を行いたい場合や、特定の条件に合致する行へ直接アクセスしたい場合など、より高度なデータアクセス制御が必要な際に非常に便利な機能です。

Copy
1<?php
2
3/**
4 * PDO::CURSOR_SCROLL 定数を使用して、スクロール可能なカーソルを扱うサンプルコードです。
5 *
6 * この関数は、インメモリのSQLiteデータベースに接続し、テストデータを挿入します。
7 * その後、PDO::CURSOR_SCROLL オプションを指定してクエリを準備し、
8 * 結果セット内を前後に移動できるカーソル動作を示します。
9 *
10 * PDO::CURSOR_SCROLL は、PDO::prepare() メソッドのオプションとして使用され、
11 * 結果セットの特定の位置からデータをフェッチすることを可能にします。
12 * ただし、この機能はデータベースドライバによってサポート状況が異なります。
13 */
14function demonstratePdoCursorScroll(): void
15{
16    // SQLiteインメモリデータベースに接続
17    // これにより、外部ファイルやサーバーの準備なしで単体で動作可能です。
18    $dsn = 'sqlite::memory:';
19    try {
20        $pdo = new PDO($dsn);
21        // エラーモードをPDO::ERRMODE_EXCEPTIONに設定し、エラー発生時に例外をスローするようにします。
22        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
23        echo "データベースに接続しました。\n";
24
25        // テスト用のテーブルを作成します。
26        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
27            id INTEGER PRIMARY KEY,
28            name TEXT NOT NULL
29            );");
30        // 既存のデータをクリアし、新しいテストデータを挿入します。
31        $pdo->exec("DELETE FROM users");
32        $pdo->exec("INSERT INTO users (name) VALUES ('Alice')");
33        $pdo->exec("INSERT INTO users (name) VALUES ('Bob')");
34        $pdo->exec("INSERT INTO users (name) VALUES ('Charlie')");
35        echo "テストデータを挿入しました。\n";
36
37        // PDO::CURSOR_SCROLL を使用して、スクロール可能なカーソルを設定します。
38        // これにより、結果セット内を前後に移動できるようになります。
39        $stmtOptions = [
40            PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL
41        ];
42
43        // SQLクエリを準備します。PDO::CURSOR_SCROLL をオプションとして渡します。
44        $stmt = $pdo->prepare("SELECT id, name FROM users ORDER BY id", $stmtOptions);
45        $stmt->execute();
46        echo "\nクエリを実行しました。スクロール可能なカーソルが設定されています。\n";
47
48        // 最初の行をフェッチします (PDO::FETCH_ORI_FIRST)。
49        $row1 = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_FIRST);
50        if ($row1) {
51            echo "最初の行 (PDO::FETCH_ORI_FIRST): ID={$row1['id']}, Name={$row1['name']}\n";
52        }
53
54        // 次の行をフェッチします (PDO::FETCH_ORI_NEXT)。
55        $row2 = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_NEXT);
56        if ($row2) {
57            echo "次の行 (PDO::FETCH_ORI_NEXT): ID={$row2['id']}, Name={$row2['name']}\n";
58        }
59
60        // カーソルを一つ前に戻して、前の行をフェッチします (PDO::FETCH_ORI_PRIOR)。
61        // PDO::CURSOR_SCROLL が有効であるため、このような操作が可能です。
62        $row1_again = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_PRIOR);
63        if ($row1_again) {
64            echo "前の行に戻る (PDO::FETCH_ORI_PRIOR): ID={$row1_again['id']}, Name={$row1_again['name']}\n";
65        }
66
67        // 残りの行を通常のループで取得することも可能です。
68        echo "\n残りの行をフェッチ (通常のループ):\n";
69        while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {
70            echo "ID={$row['id']}, Name={$row['name']}\n";
71        }
72
73        // ステートメントとデータベース接続をクローズし、リソースを解放します。
74        $stmt = null;
75        $pdo = null;
76        echo "\nデータベース接続を閉じました。\n";
77
78    } catch (PDOException $e) {
79        // PDO関連のエラーが発生した場合の処理
80        echo "データベースエラー: " . $e->getMessage() . "\n";
81    } catch (Exception $e) {
82        // その他の予期せぬエラーが発生した場合の処理
83        echo "一般エラー: " . $e->getMessage() . "\n";
84    }
85}
86
87// 関数を実行してサンプルコードの動作を確認します。
88demonstratePdoCursorScroll();

PHPのPDO::CURSOR_SCROLLは、PDO（PHP Data Objects）クラスが提供する定数の一つで、整数値を持ちます。この定数は、データベースからクエリ結果を取得する際のカーソル動作を制御するために使用されます。

具体的には、この定数をPDO::prepare()メソッドのオプションとして指定すると、結果セット内を前後に自由に移動できる「スクロール可能なカーソル」が有効になります。通常、結果セットのデータは一行ずつ順にしかアクセスできませんが、PDO::CURSOR_SCROLLを使用することで、結果セットの先頭、最後、特定の位置、または現在の位置から一つ前後の行といった、より柔軟なデータ取得が可能になります。

サンプルコードでは、この定数を設定してSQLクエリを準備し、PDO::FETCH_ORI_FIRSTで最初の行、PDO::FETCH_ORI_NEXTで次の行、そしてPDO::FETCH_ORI_PRIORで前の行に戻ってデータをフェッチする様子を示しています。これにより、結果セットを効率的に操作できる点が特徴です。ただし、この機能は利用するデータベースドライバによってサポート状況が異なりますので、事前に確認が必要です。