【PHP8.x】PDO::lastInsertId()メソッドの使い方

Copy
1<?php
2
3/**
4 * PDO::lastInsertId() が 0 を返すケースを示すサンプルコード。
5 *
6 * lastInsertId() メソッドは、通常 AUTO_INCREMENT (またはそれに相当する自動採番)
7 * カラムを持つテーブルにデータを挿入した際に、その採番されたIDを返します。
8 *
9 * この例では、SQLite のデータベースで `AUTO_INCREMENT` キーワードを使用せず
10 * `INTEGER PRIMARY KEY` カラムを持つテーブルに挿入した場合に、
11 * lastInsertId() が 0 を返す状況を示します。
12 * これは、PDOが認識できる自動採番シーケンスがデフォルトでは存在しないためです。
13 */
14function demonstrateLastInsertIdReturnsZero(): void
15{
16    // SQLite のインメモリデータベースに接続
17    // 本番環境では、データベース接続情報を環境変数などで管理することを推奨します。
18    try {
19        $pdo = new PDO('sqlite::memory:');
20        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
21        echo "データベースに接続しました。\n\n";
22    } catch (PDOException $e) {
23        echo "データベース接続エラー: " . $e->getMessage() . "\n";
24        return;
25    }
26
27    // --- AUTO_INCREMENT キーワードを持たないテーブルを作成 ---
28    // SQLite では INTEGER PRIMARY KEY は rowid のエイリアスとして機能し、
29    // IDを自動採番しますが、PDO::lastInsertId() はデフォルトでその ID を返しません。
30    $pdo->exec("
31        CREATE TABLE IF NOT EXISTS products (
32            id INTEGER PRIMARY KEY,
33            name TEXT NOT NULL,
34            price REAL
35        );
36    ");
37    echo "テーブル 'products' を作成しました。\n";
38
39    // --- データ挿入 ---
40    // 'id' カラムは自動採番されますが、PDO::lastInsertId() はそれを認識しません。
41    $stmt = $pdo->prepare("INSERT INTO products (name, price) VALUES (?, ?)");
42    $stmt->execute(['Apple', 1.50]);
43    echo "データを挿入しました (Apple)。\n";
44
45    // --- PDO::lastInsertId() の呼び出し ---
46    // AUTO_INCREMENT キーワードがないため、ここでは 0 が返されます。
47    $lastId = $pdo->lastInsertId();
48
49    echo "\n--- PDO::lastInsertId() の結果 ---\n";
50    echo "最後に挿入されたID: " . $lastId . "\n";
51
52    if ($lastId === '0' || $lastId === '') {
53        echo "上記の lastInsertId() が '0' または空文字列を返したのは、\n";
54        echo "このテーブルの主キーに AUTO_INCREMENT の指定がなく、\n";
55        echo "PDOがデフォルトで取得できる自動採番IDが存在しないためです。\n";
56        echo "これは、lastInsertId() が常に値を返すわけではないことを示しています。\n";
57    } else {
58        echo "PDO::lastInsertId() が予期せぬ値を返しました。\n";
59    }
60
61    // データベース接続を閉じる (スクリプト終了時に自動的に閉じられます)
62    $pdo = null;
63    echo "\nデータベース接続を閉じました。\n";
64}
65
66// 関数を実行
67demonstrateLastInsertIdReturnsZero();

PDO::lastInsertId()メソッドは、データベースに新しくデータを追加した際に、自動で割り振られたID（例えばAUTO_INCREMENTで採番されたID）を取得するために使用します。このメソッドは、オプションでシーケンス名を引数に取りますが、通常は指定せず、最後に挿入されたIDを文字列として返します。

しかし、データベースやテーブルの設定によっては、常に有効なIDが返されるわけではありません。提供されたサンプルコードは、lastInsertId()が「0」を返す具体的なケースを示しています。

サンプルではSQLiteデータベースを使用し、INTEGER PRIMARY KEYとして設定されたカラムにデータを挿入しています。SQLiteのINTEGER PRIMARY KEYはIDを自動で採番する機能を持っていますが、PHPのPDOは、AUTO_INCREMENTというキーワードが明示的に指定されていない場合、デフォルトではこの自動採番されたIDを認識できません。

そのため、データ挿入後にもかかわらず、PDO::lastInsertId()を呼び出すと「0」という文字列が返されます。この挙動は、lastInsertId()メソッドが、データベースの自動採番シーケンスをPDOが認識できる形で設定していないと、期待するIDではなく「0」や空文字列を返す可能性があることを示しています。システム開発において、自動採番IDの取得が正しく行われているかを確認する上で重要なポイントです。

Copy
1<?php
2
3/**
4 * PDO::lastInsertId() メソッドの使用例を示します。
5 * SQLite データベースに接続し、データを挿入して、
6 * 最後に挿入された行のIDを取得する方法を説明します。
7 */
8function demonstrateLastInsertId(): void
9{
10    // SQLiteデータベースファイルのパス
11    // スクリプトと同じディレクトリに 'test.db' ファイルが作成されます。
12    $dbFile = './test.db';
13    $pdo = null; // PDOオブジェクトを初期化
14
15    try {
16        // データベースに接続
17        // 'sqlite:' の後にデータベースファイルのパスを指定します。
18        $pdo = new PDO('sqlite:' . $dbFile);
19
20        // エラーモードを例外に設定し、エラー発生時にPDOExceptionをスローさせます。
21        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
22
23        echo "データベースに接続しました。\n";
24
25        // 'users' テーブルが存在しない場合に作成します。
26        // idはAUTOINCREMENT（自動増分）プライマリキーとして定義します。
27        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
28            id INTEGER PRIMARY KEY AUTOINCREMENT,
29            name TEXT NOT NULL,
30            email TEXT UNIQUE NOT NULL
31        )");
32        echo "テーブル 'users' が存在しない場合は作成しました。\n";
33
34        // 挿入するデータ
35        $userName = 'Jane Doe';
36        $userEmail = 'jane.doe@example.com';
37
38        // プリペアドステートメントを使用してSQLインジェクション攻撃を防ぎます。
39        // 値のプレースホルダーとして ':name' と ':email' を使用します。
40        $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (:name, :email)");
41
42        // パラメータを実際の値にバインドします。
43        $stmt->bindParam(':name', $userName);
44        $stmt->bindParam(':email', $userEmail);
45
46        // SQLステートメントを実行します。
47        $stmt->execute();
48
49        echo "ユーザーデータ (Name: {$userName}, Email: {$userEmail}) を挿入しました。\n";
50
51        // PDO::lastInsertId() を呼び出して、最後に挿入された行のIDを取得します。
52        // 引数 $name はPostgreSQLなどで特定のシーケンス名を指定する場合に利用されますが、
53        // SQLiteやMySQLのAUTO_INCREMENTカラムでは通常指定は不要です。
54        $lastId = $pdo->lastInsertId();
55
56        echo "最後に挿入された行のID: " . $lastId . "\n";
57
58    } catch (PDOException $e) {
59        // データベース関連のエラーをキャッチし、エラーメッセージを表示します。
60        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
61    } finally {
62        // PDOオブジェクトがスコープを外れるとデータベース接続は自動的に閉じられます。
63        // 明示的に null を代入して接続を閉じることも可能です。
64        $pdo = null;
65    }
66}
67
68// 上記の関数を実行して、PDO::lastInsertId() の動作を確認します。
69demonstrateLastInsertId();

このサンプルコードは、PHPのPDOクラスで提供されるlastInsertId()メソッドの利用方法を、システムエンジニアを目指す初心者向けに解説しています。lastInsertId()メソッドは、データベースに新しい行を挿入した後、その行に自動的に割り当てられたID（例えば、AUTO_INCREMENTやAUTOINCREMENT属性を持つカラムの値）を取得する際に使用されます。

コードではまずSQLiteデータベースに接続し、idカラムが自動的に増加するように設定されたusersテーブルを作成します。次に、SQLインジェクション攻撃を防ぐためにプリペアドステートメントを使用し、安全にユーザーデータを挿入します。データ挿入が完了した後、$pdo->lastInsertId()を呼び出すことで、直前に挿入されたユーザーのIDを文字列として取得し、コンソールに表示します。

メソッドの引数?string $name = nullはオプションで、PostgreSQLのような特定のデータベースシステムでシーケンス名を指定する必要がある場合に利用されますが、SQLiteやMySQLの自動採番カラムを使用する際は通常、この引数を省略できます。戻り値は常に文字列型で、最後に挿入されたIDを表します。この機能は、データ挿入後に新しく作成されたレコードのIDを利用して関連する処理を行う場合に非常に役立ちます。