【実務・中級編】ADOのErrorsコレクションを駆使した、詳細なDBエラーログの自動生成ツール – Access VBA解析バイブル

スポンサーリンク
スポンサーリンク

「Err.Description」で満足している開発者へ。SQL Serverの深淵を暴く、ADOエラーログ設計の極意

多くのAccess VBA開発者が、エラーハンドリングにおいて致命的な「怠慢」を犯している。

エラーが発生した際、`MsgBox Err.Description` を表示して、「あ、エラーが出たな」と察する。あるいは、単純に `Err.Number` をログに書き込む。もし君がこれだけで満足しているなら、君の設計したシステムは、本番環境で複雑なデータ不整合やデッドロックが発生した瞬間に、無力な鉄屑へと成り下がるだろう。

特に、バックエンドにSQL Serverを採用している場合、VBAの `Err` オブジェクトが握っている情報は、氷山の一角に過ぎない。氷山の水面下には、SQLState や NativeError といった、原因を特定するために不可欠な「真実」が眠っているのだ。

本稿では、ADO(ActiveX Data Objects)の `Errors` コレクションを徹底的に使い倒し、保守性を極限まで高めるための「プロフェッショナルなエラーログ生成アーキテクチャ」を伝授する。

1. なぜ VBA の `Err` だけでは不十分なのか

まず、アーキテクチャの根本的な違いを理解せよ。

VBAの `Err` オブジェクトは、あくまで「VBAランタイム」が検知したエラーを保持するものだ。一方で、SQL Serverとの通信において発生するエラー(制約違反、タイムアウト、権限不足など)は、データベースエンジンから返される。

ADOを使用している場合、これらの詳細な情報は、VBAの `Err` オブジェクトに集約されるのではなく、`ADODB.Connection.Errors` コレクションの中に格納される。

情報の種類 役割 実務上の重要性
Err.Description VBAが解釈したエラー文 ユーザーへの表示には良いが、原因特定には不十分。
SQLState SQL標準に基づくエラーコード 通信プロトコルやドライバ層のエラー特定に必須。
NativeError SQL Server固有のエラー番号 最重要。 SQL Serverの公式ドキュメントと照合するための鍵。

これらを取得せずに「型が違います」という抽象的なログだけを残す行為は、火事の現場で「煙が出ています」と報告するだけで、火元を特定しようとしない消防士と同じだ。

2. 堅牢なエラーログ生成の設計指針

単にログを出すのではない。「解析可能なログ」を作るのだ。設計には以下の3原則を組み込む。

1. コンテキストの保持: どのSQL文を実行しようとして、どのパラメータを渡していたのかを記録する。
2. エラーチェーンの走査: `Errors` コレクションをループし、発生したすべてのエラーを漏らさず抽出する。
3. トランザクションとの整合性: エラー発生時は必ず `Rollback` を実行し、ログ出力自体がトランザクションの失敗によって消失しないように設計する。

3. プロダクション・コード例

以下に、そのまま実務に投入できるレベルのモジュール構成を示す。

3.1 ログ出力エンジン (`modLogger`)

ファイル出力を行う。ここでは、将来的な拡張性を考慮し、`FileSystemObject` を使用する。

Option Explicit

' ログレベルの定義
Public Enum LogLevel
    LogLevel_Info = 1
    LogLevel_Warning = 2
    LogLevel_Error = 3
End Enum

''' <summary>
''' 詳細なエラー情報をファイルに記録する
''' </summary>
Public Sub WriteErrorLog(ByVal contextInfo As String, ByVal adoSess As ADODB.Connection)
    On Error Resume Next ' ログ出力自体の失敗でメイン処理を止めない
    
    Dim fso As Object
    Dim logFile As Object
    Dim logPath As String
    Dim errObj As ADODB.Error
    Dim logMsg As String
    
    Set fso = CreateObject("Scripting.FileSystemObject")
    logPath = CurrentProject.Path & "\ErrorLog_" & Format(Date, "yyyymmdd") & ".log"
    
    ' ファイルを開く(追記モード)
    Set logFile = fso.OpenTextFile(logPath, 8, True)
    
    logMsg = "==================================================" & vbCrLf
    logMsg = logMsg & "[" & Now & "] [ERROR] " & contextInfo & vbCrLf
    
    ' ADOのErrorsコレクションを走査(ここが肝)
    If Not adoSess Is Nothing Then
        If adoSess.Errors.Count > 0 Then
            For Each errObj In adoSess.Errors
                logMsg = logMsg & "  -> [NativeError: " & errObj.NativeError & "] " & _
                                 "[SQLState: " & errObj.SQLState & "] " & _
                                 "[Source: " & errObj.Source & "] " & _
                                 "[Description: " & errObj.Description & "]" & vbCrLf
            Next errObj
        Else
            ' ADOエラーがない場合はVBA標準エラーを記録
            logMsg = logMsg & "  -> [VBA Error: " & Err.Number & "] " & Err.Description & vbCrLf
        End If
    Else
        logMsg = logMsg & "  -> [VBA Error: " & Err.Number & "] " & Err.Description & vbCrLf
    End If
    
    logMsg = logMsg & "==================================================" & vbCrLf
    
    logFile.WriteLine logMsg
    logFile.Close
    
    Set logFile = Nothing
    Set fso = Nothing
End Sub

3.2 データアクセス・ロジック (`modDB`)

トランザクション管理とエラーハンドリングを組み合わせた、実戦的な実装例だ。

Option Explicit

''' <summary>
''' トランザクションを用いたデータ更新処理の例
''' </summary>
Public Sub ExecuteUpdateTransaction(ByVal sql As String)
    Dim conn As ADODB.Connection
    Set conn = New ADODB.Connection
    
    ' 接続文字列(環境に合わせて調整すること)
    Dim connStr As String
    connStr = "Provider=SQLOLEDB;Data Source=YOUR_SERVER;Initial Catalog=YOUR_DB;Integrated Security=SSPI;"
    
    On Error GoTo ErrorHandler
    
    ' 1. 接続
    conn.Open connStr
    
    ' 2. トランザクション開始
    conn.BeginTrans
    
    ' 3. SQL実行
    Debug.Print "Executing: " & sql
    conn.Execute sql
    
    ' 4. コミット
    conn.CommitTrans
    Debug.Print "Transaction Committed Successfully."

ExitPoint:
    ' 後処理
    If Not conn Is Nothing Then
        If conn.State = adStateOpen Then conn.Close
    End If
    Set conn = Nothing
    Exit Sub

ErrorHandler:
    ' 5. エラー発生時は即座にロールバック
    ' ※connが有効な場合のみ実行
    If Not conn Is Nothing Then
        If conn.State = adStateOpen Then
            conn.RollbackTrans
            Debug.Print "Transaction Rolled Back."
        End If
    End If
    
    ' 6. 詳細ログの生成(コンテキストとして実行SQLを渡す)
    Call WriteErrorLog("SQL Execution Failed: " & sql, conn)
    
    ' ユーザーへの通知は最小限に
    MsgBox "データ更新中に致命的なエラーが発生しました。管理者に連絡してください。", vbCritical
    
    Resume ExitPoint
End Sub

4. アーキテクトからの警告:運用における落とし穴

この実装を導入する際、以下の3点に注意せよ。これを知らなければ、ツールは逆にシステムの足を引っ張ることになる。

① ログファイルの肥大化と権限

`FileSystemObject` でファイルに書き出す設計は、データベースへの負荷を避けられる利点がある。しかし、サーバー上の共有フォルダに書き出す場合、実行ユーザーの書き込み権限が適切に設定されているか確認せよ。また、ログファイルが数GBに膨れ上がらないよう、定期的なローテーション(月次削除など)を運用ルールに組み込むこと。

② セキュリティと機密情報

エラーログに `contextInfo` としてSQL文をそのまま渡すと、`INSERT` 文に含まれる個人情報(氏名、住所、パスワード等)がそのままログファイルに平文で記録される。これは重大なセキュリティリスクだ。
実務では、SQL文から機密情報をマスキングする、あるいはパラメータ値を別途ログに出さない等の配慮を検討せよ。

③ トランザクションの「迷子」を防ぐ

`On Error GoTo` を使う際、`RollbackTrans` を呼び忘れると、接続がプールされている場合に「トランザクションが開始されたままの接続」が返却され、後続の処理で予期せぬデッドロックを引き起こす。必ず `If conn.State = adStateOpen Then conn.RollbackTrans` のように、状態を確認してから実行する防御的プログラミングを徹底すること。

結論

「動けばいい」という考え方は、プロフェッショナルではない。
真に価値のある業務自動化ツールとは、「壊れたときに、なぜ壊れたのかを即座に、かつ正確に教えてくれるツール」だ。

ADOの `Errors` コレクションを掌握し、`NativeError` をログに刻む。この一歩が、君の作るシステムの信頼性を、一段上のステージへと引き上げる。

タイトルとURLをコピーしました