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

Copy
1<?php
2
3/**
4 * PDOStatement::errorCode() の使用例を示します。
5 * 意図的にエラーを発生させ、そのエラーコードを取得します。
6 * PDO::ERRMODE_SILENT を使用して、PDO が例外をスローせず、
7 * errorCode() を呼び出せるようにしています。
8 */
9function demonstratePdoErrorCode(): void
10{
11    // SQLite のインメモリデータベースに接続します。
12    // 実際にファイルを作成しないため、手軽に試すことができます。
13    $dsn = 'sqlite::memory:';
14
15    try {
16        $pdo = new PDO($dsn);
17        // エラーモードをサイレントに設定します。
18        // これにより、SQLエラーが発生しても例外がスローされず、
19        // errorCode() メソッドを呼び出すことができます。
20        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT);
21
22        // 存在しないテーブル 'non_existent_table' をクエリすることで、
23        // 意図的に SQL エラーを発生させます。
24        $sql = "SELECT * FROM non_existent_table";
25        $stmt = $pdo->prepare($sql);
26
27        if ($stmt === false) {
28            // prepare() が失敗した場合、PDO のエラー情報を取得します。
29            // prepare() は PDOStatement オブジェクトを返さないため、
30            // PDO 自体の errorCode() を使用します。
31            $pdoErrorCode = $pdo->errorCode();
32            echo "PDO prepare error: SQLSTATE [{$pdoErrorCode}]\n";
33            echo "Error Info: " . implode(" | ", $pdo->errorInfo()) . "\n";
34            return;
35        }
36
37        // ステートメントを実行します。
38        // 存在しないテーブルへのアクセスは失敗します。
39        $executeResult = $stmt->execute();
40
41        if ($executeResult === false) {
42            // execute() が失敗した場合、PDOStatement のエラー情報を取得します。
43            $stmtErrorCode = $stmt->errorCode();
44            echo "SQLSTATE エラーコード: [{$stmtErrorCode}]\n";
45
46            // errorInfo() は、より詳細なエラー情報（SQLSTATE、ドライバ固有のエラーコード、ドライバ固有のエラーメッセージ）を返します。
47            $errorInfo = $stmt->errorInfo();
48            echo "詳細エラー情報:\n";
49            echo " - SQLSTATE: {$errorInfo[0]}\n";
50            echo " - ドライバ固有のエラーコード: {$errorInfo[1]}\n";
51            echo " - ドライバ固有のエラーメッセージ: {$errorInfo[2]}\n";
52        } else {
53            echo "クエリはエラーなしで成功しました。\n";
54            // エラーがない場合、errorCode() は '00000' を返すことが多いです。
55            echo "成功時のSQLSTATE エラーコード: [" . ($stmt->errorCode() ?? 'null') . "]\n";
56        }
57
58    } catch (PDOException $e) {
59        // データベース接続自体が失敗した場合の例外をキャッチします。
60        echo "データベース接続エラー: " . $e->getMessage() . "\n";
61    }
62}
63
64// 関数の実行
65demonstratePdoErrorCode();

PHPのPDOStatement::errorCode()は、データベースに対する直前のSQL操作でエラーが発生した際に、そのエラーのSQLSTATEコード（5桁の標準エラーコード）を取得するためのメソッドです。引数は不要で、戻り値としてエラーコードを示す文字列、またはエラーがない場合は'00000'、PHP 8からはnullを返すことがあります。

このサンプルコードは、存在しないテーブルにアクセスすることで意図的にデータベースエラーを発生させ、そのエラーコードを取得する具体的な方法を示しています。特に、PDOがエラー時に例外をスローしないよう、PDO::ATTR_ERRMODEをPDO::ERRMODE_SILENTに設定している点が重要です。これにより、errorCode()メソッドを呼び出してエラーをチェックできるようにしています。

SQLクエリをprepare()し、そのPDOStatementオブジェクトに対してexecute()を実行した後、もし操作が失敗した場合に$stmt->errorCode()を呼び出すことで、その実行に関するSQLSTATEコードが得られます。例えば、テーブルが見つからないといったエラーコードを確認できます。エラーがない場合は通常'00000'が返されますが、より詳細なエラー情報が必要な場合はerrorInfo()メソッドを利用できます。この機能は、データベース操作の安定性を確保し、エラーハンドリングを適切に行う上で非常に重要です。