【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()メソッドを利用できます。この機能は、データベース操作の安定性を確保し、エラーハンドリングを適切に行う上で非常に重要です。

Copy
1<?php
2
3/**
4 * PDOStatement::errorCode() の使用例。
5 *
6 * この関数は、PDO (PHP Data Objects) を使用してデータベース操作を行う際に、
7 * SQL操作でエラーが発生した場合にそのエラーコードを取得する方法を示します。
8 * PDOStatement::errorCode() は、直近のプリペアドステートメントによって実行された操作の
9 * SQLSTATE エラーコードを文字列で返します。エラーが発生しなかった場合は '00000' を返します。
10 * 失敗した場合や情報がない場合は null を返すことがあります。
11 *
12 * システムエンジニアを目指す初心者の方へ:
13 * データベース操作ではエラーハンドリングが非常に重要です。このメソッドを使うことで、
14 * どのような種類のデータベースエラーが発生したかを特定し、適切な対応を行うことができます。
15 * 例外処理と組み合わせることで、より堅牢なアプリケーションを構築できます。
16 */
17function demonstratePdoStatementErrorCode(): void
18{
19    // データベース接続情報（ご自身の環境に合わせて変更してください）
20    // この例ではMySQLを想定していますが、PDOは多くのデータベースに対応しています。
21    $dsn = 'mysql:host=localhost;dbname=test_db;charset=utf8mb4';
22    $user = 'root';
23    $password = '';
24
25    try {
26        // PDOオブジェクトを作成し、データベースに接続します。
27        // ここではエラーモードをPDO::ERRMODE_SILENTに設定しています。
28        // これは、PDOStatement::errorCode() や PDOStatement::errorInfo() を使って
29        // エラー情報を手動で取得するデモンストレーションに適しています。
30        // 通常のアプリケーションでは PDO::ERRMODE_EXCEPTION を使用し、try-catch で例外を捕捉するのが一般的です。
31        $pdo = new PDO($dsn, $user, $password, [
32            PDO::ATTR_ERRMODE          => PDO::ERRMODE_SILENT, // エラー時に例外を投げず、errorCode()で確認するモード
33            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,     // 結果セットを連想配列として取得する
34            PDO::ATTR_EMULATE_PREPARES => false,                // プリペアドステートメントのエミュレーションを無効化（推奨）
35        ]);
36
37        echo "--- エラーが発生するSQL操作の例 ---\n";
38
39        // 存在しないテーブルへのSELECTクエリを準備します。
40        // このクエリはデータベースレベルでエラーを引き起こすことを意図しています。
41        $sqlWithError = "SELECT * FROM non_existent_table WHERE id = ?";
42        $stmtWithError = $pdo->prepare($sqlWithError);
43
44        // クエリを実行します。execute() は成功すると true、失敗すると false を返します。
45        if ($stmtWithError->execute([1])) {
46            echo "エラーを意図したクエリが予期せず成功しました。\n";
47            // このブロックは通常実行されませんが、念のためerrorCode()を確認します。
48            $errorCode = $stmtWithError->errorCode();
49            echo "PDOStatement::errorCode(): " . ($errorCode ?? 'null') . " (エラーなしの場合は'00000')\n";
50        } else {
51            // execute() が失敗した場合、PDOStatement::errorCode() を呼び出してエラーコードを取得します。
52            $errorCode = $stmtWithError->errorCode();
53            echo "SQL操作が失敗しました。\n";
54            echo "PDOStatement::errorCode(): " . ($errorCode ?? 'null') . "\n";
55
56            // より詳細なエラー情報を取得するには PDOStatement::errorInfo() を使用します。
57            // errorInfo() は、SQLSTATEコード、ドライバー固有のエラーコード、ドライバー固有のエラーメッセージを含む配列を返します。
58            $errorInfo = $stmtWithError->errorInfo();
59            echo "詳細エラー情報（SQLSTATE, Driver Code, Driver Message）: ";
60            echo "[" . $errorInfo[0] . ", " . ($errorInfo[1] ?? 'N/A') . ", " . ($errorInfo[2] ?? 'N/A') . "]\n";
61        }
62
63        echo "\n--- 正常に実行されるSQL操作の例 ---\n";
64
65        // 正常に実行される単純なクエリを準備します。
66        // 多くの場合、データベースに接続できることを確認するためのクエリです。
67        $sqlSuccess = "SELECT 1 FROM DUAL"; // MySQLなどの環境で動作するダミークエリ
68        // SQLiteやPostgreSQLの場合は "SELECT 1" で十分です。
69        $stmtSuccess = $pdo->prepare($sqlSuccess);
70
71        // クエリを実行します。
72        if ($stmtSuccess->execute()) {
73            echo "SQL操作が正常に完了しました。\n";
74            // 正常な操作の後、errorCode() は '00000' を返します。
75            $errorCode = $stmtSuccess->errorCode();
76            echo "PDOStatement::errorCode(): " . ($errorCode ?? 'null') . "\n";
77        } else {
78            // このブロックは通常実行されませんが、念のためエラー情報を表示します。
79            echo "正常なクエリが予期せず失敗しました。\n";
80            $errorCode = $stmtSuccess->errorCode();
81            echo "PDOStatement::errorCode(): " . ($errorCode ?? 'null') . "\n";
82            $errorInfo = $stmtSuccess->errorInfo();
83            echo "詳細エラー情報: [" . $errorInfo[0] . ", " . ($errorInfo[1] ?? 'N/A') . ", " . ($errorInfo[2] ?? 'N/A') . "]\n";
84        }
85
86    } catch (PDOException $e) {
87        // データベース接続自体が失敗した場合など、PDOオブジェクトの生成でエラーが発生した場合の処理。
88        echo "データベース接続エラー: " . $e->getMessage() . "\n";
89    } catch (Exception $e) {
90        // その他の予期せぬエラーが発生した場合の処理。
91        echo "予期せぬエラー: " . $e->getMessage() . "\n";
92    }
93}
94
95// 関数を実行してデモンストレーションを開始します。
96demonstratePdoStatementErrorCode();

PDOStatement::errorCode()は、PHPでデータベース操作を行う際に、SQLステートメントの実行で発生したエラーのSQLSTATEコードを特定するために使用されるメソッドです。このメソッドはPDOStatementオブジェクトに属し、引数はなく、呼び出し時に直近のSQL操作のエラーコードを取得します。

戻り値は文字列またはnullで、具体的には、操作が正常終了した場合は'00000'を、エラーが発生した場合は該当するSQLSTATEコードを返します。エラー情報が利用できない場合にはnullが返されることもあります。

システムエンジニアを目指す初心者の方にとって、データベース操作におけるエラーハンドリングは非常に重要です。このメソッドを使うことで、どのような種類のデータベースエラーが発生したかを特定し、適切な対応を行うことができ、堅牢なシステム構築に役立ちます。サンプルコードではエラーモードをPDO::ERRMODE_SILENTに設定していますが、一般的なアプリケーションではPDO::ERRMODE_EXCEPTIONを設定し、try-catch文で例外を捕捉してエラーを処理することが推奨されます。より詳細なエラー情報を取得したい場合は、PDOStatement::errorInfo()メソッドも利用できます。