TRY...CATCH でエラーを処理する
ヒント
詳細については、「 テキストと画像 」タブを参照してください。
実稼働データベース アプリケーションでは、予期しない状況を適切に処理する必要があります。 ゼロ除算、制約違反、接続タイムアウト、および無効なデータはすべてエラーの原因となる可能性があります。 ハンドルされないエラーにより、不明確なエラー メッセージ、不完全なトランザクション、またはアプリケーションのクラッシュが発生します。 適切なエラー処理により、T-SQL コードが予測どおりに失敗し、意味のあるフィードバックが提供されます。
データベース操作は、複数のユーザー、外部システム、および予測できないデータ入力と同時にやり取りします。 再試行によって失敗した操作から復旧する可能性があるアプリケーション コードとは異なり、データベース エラーにより、データが不整合な状態になり、一部の行が挿入されたり挿入されなかったり、ロックが無期限に保持されたりする可能性があります。 エラー処理では、これらの混同障害モードが制御された予測可能な応答に変換されます。
適切に設計されたエラー処理により、いくつかの方法でコードが改善されます。
データ整合性の保護: 操作が途中で失敗した場合、適切なエラー処理により、すべての変更が一緒にコミットされるか、どれも保存されないようにします。 これを行わないと、複数ステップのプロセスによって、孤立したレコード、不一致の合計、または破損したリレーションシップがデータベースに残る可能性があります。
デバッグの効率: 行番号、プロシージャ名、特定のエラー メッセージなどのエラーの詳細をキャプチャすると、トラブルシューティングが高速化されます。 ログであいまいなエラーを検索する代わりに、エラーが発生した場所と理由を正確に特定できます。
ユーザー エクスペリエンス: アプリケーションでは、データベースエラーではなく、"製品 ID が存在しません" などの意味のあるメッセージを表示できます。 これは、ユーザーが問題の原因とその修正方法を理解するのに役立ちます。
操作の可視性: 専用テーブルにエラーを記録すると、パフォーマンスの問題を示すバグやタイムアウト エラーを示す定期的な制約違反などのパターンを識別するのに役立つ監査証跡が作成されます。
正常な低下: 1 つの操作が失敗した場合、エラー処理により、バッチまたはストアド プロシージャ全体をクラッシュするのではなく、残りのコードを続行または代替アクションを実行できます。
T-SQL エラー処理を実装する
T-SQL は、他のプログラミング言語での例外処理と同様に、 TRY...CATCH ブロックを介して構造化されたエラー処理を提供します。
TRY ブロックでエラーが発生すると、実行は CATCH ブロックに転送され、そこでエラーを適切に処理できます。
BEGIN TRY
-- TRY block contains code that might cause an error
-- If an error occurs here, execution jumps to the CATCH block
SELECT 1/0; -- This causes a division by zero error
END TRY
BEGIN CATCH
-- CATCH block handles the error
-- This code runs only if an error occurred in the TRY block
PRINT 'An error occurred';
END CATCH;
エラー処理がないと、同じコードがエラー メッセージで終了します。
SELECT 1/0; -- Msg 8134: Divide by zero error encountered
注
TRY...CATCH すべてのエラーをキャッチすることはできません。 コンパイル エラー (構文エラー、オブジェクトがありません) と、接続を閉じる重大度が 20 以上のエラーは、同じセッション内でキャッチできません。
エラー情報を取得する
CATCH ブロック内で、SQL Server には、発生したエラーに関する詳細を取得するための次の関数が用意されています。
| 機能 | Description |
|---|---|
ERROR_NUMBER() |
エラー番号を返します。 |
ERROR_MESSAGE() |
完全なエラー メッセージ テキストを返します |
ERROR_SEVERITY() |
エラーの重大度 (0 から 25) を返します。 |
ERROR_STATE() |
エラー状態番号を返します。 |
ERROR_LINE() |
エラーが発生した行番号を返します。 |
ERROR_PROCEDURE() |
ストアド プロシージャまたはトリガーの名前を返します。 |
次の例では、エラーの詳細をキャプチャし、後で分析するためにテーブルにログを記録する方法を示します。
BEGIN TRY
-- Attempt an operation that might fail
INSERT INTO SalesLT.Customer (CustomerID, FirstName, LastName)
VALUES (1, 'Test', 'Customer'); -- Duplicate key causes error
END TRY
BEGIN CATCH
-- Log error details to a table using the ERROR_* functions
INSERT INTO ErrorLog (
ErrorTime,
ErrorNumber,
ErrorSeverity,
ErrorState,
ErrorProcedure,
ErrorLine,
ErrorMessage
)
VALUES (
GETDATE(),
ERROR_NUMBER(), -- The error number (e.g., 2627 for duplicate key)
ERROR_SEVERITY(), -- Severity level (0-25)
ERROR_STATE(), -- Error state for debugging
ISNULL(ERROR_PROCEDURE(), 'Ad hoc query'), -- NULL if not in a procedure
ERROR_LINE(), -- Line number where error occurred
ERROR_MESSAGE() -- Full error message text
);
-- Re-raise the error to the calling application
THROW;
END CATCH;
ヒント
エラーを再評価する前に、必ずログに記録してください。
THROWまたはRAISERRORを使用すると、再度呼び出された場合、エラー関数はNULLを返します。
TRY を使用してトランザクションを処理する...キャッチ
トランザクション内でエラーが発生した場合は、コミットされていない作業を明示的にロールバックする必要があります。
@@TRANCOUNT関数は、トランザクションがアクティブかどうかを示します。
BEGIN TRY
-- Start a transaction to group multiple operations
BEGIN TRANSACTION;
-- First operation: update product prices
UPDATE SalesLT.Product
SET ListPrice = ListPrice * 1.05
WHERE ProductCategoryID = 5;
-- Second operation: update order totals
-- If this fails, we want to undo the first update too
UPDATE SalesLT.SalesOrderHeader
SET TotalDue = TotalDue * 1.05
WHERE CustomerID = 12345;
-- Both operations succeeded, make changes permanent
COMMIT TRANSACTION;
END TRY
BEGIN CATCH
-- Check if a transaction is still active before rolling back
-- Some errors auto-rollback, so @@TRANCOUNT might be 0
IF @@TRANCOUNT > 0
ROLLBACK TRANSACTION; -- Undo all changes from this transaction
-- Re-raise the error so the caller knows something failed
THROW;
END CATCH;
@@TRANCOUNTチェックは、次の理由から重要です。
- 前にエラーが発生する可能性があります。
BEGIN TRANSACTION - 一部のエラーは、
CATCHに到達する前にトランザクションを自動的にロールバックします。 - アクティブなトランザクションなしでロールバックしようとすると、別のエラーが発生する
Important
@@TRANCOUNT ブロックでROLLBACK TRANSACTIONを呼び出す前に、常にCATCHを確認してください。 これにより、 "ROLLBACK TRANSACTION 要求に対応する BEGIN TRANSACTION がありません" というエラーが表示されなくなります。
THROW を使用してカスタム エラーを発生させる
THROW ステートメントは、カスタム エラー番号とメッセージを含む例外を発生させます。 これを使用して、アプリケーション固有のエラー状態を通知します。
CREATE PROCEDURE ProcessOrder
@OrderID INT,
@Quantity INT
AS
BEGIN
BEGIN TRY
-- Validate input and raise custom errors for invalid data
IF @Quantity <= 0
THROW 50001, 'Quantity must be greater than zero.', 1;
IF NOT EXISTS (SELECT 1 FROM Orders WHERE OrderID = @OrderID)
THROW 50002, 'Order not found.', 1;
-- Process the order
UPDATE Orders
SET Quantity = @Quantity
WHERE OrderID = @OrderID;
END TRY
BEGIN CATCH
-- Log the error before reraising
EXEC LogError;
-- THROW without parameters reraises the current error
THROW;
END CATCH;
END;
ユーザー定義エラーのカスタム エラー番号は 5,0000 以上である必要があります。 状態パラメーター (例では 1) は、エラーが発生した場所を特定するのに役立つ 1 ~ 255 のユーザー定義値です。
書式設定されたメッセージに RAISERROR を使用する
RAISERROR は、printf スタイルのパラメーター置換など、 THROWよりも多くの書式設定オプションを提供します。 エラー メッセージにランタイム値を含めると、ログを掘り起こしたり、問題を再現したりすることなく、エラーの原因となったデータを正確に確認できるため、デバッグが容易になります。
DECLARE @ProductName NVARCHAR(100) = 'Widget Pro';
DECLARE @CurrentStock INT = 5;
DECLARE @RequestedQty INT = 10;
IF @CurrentStock < @RequestedQty
BEGIN
RAISERROR(
'Insufficient stock for product "%s". Available: %d, Requested: %d',
16, -- Severity
1, -- State
@ProductName,
@CurrentStock,
@RequestedQty
);
END;
注
THROW は、新しいコードの方が簡単で、常にスタック トレースが含まれるため、推奨される方法です。 書式設定されたメッセージまたは既存のエラー処理パターンとの互換性が必要な場合は、 RAISERROR を使用します。
入れ子になったエラー処理を実装する
他のプロシージャを呼び出すストアド プロシージャには、調整されたエラー処理が必要です。 各レベルは、独自のクリーンアップを処理し、エラーを適切に伝達する必要があります。
CREATE PROCEDURE OuterProcedure
AS
BEGIN
BEGIN TRY
-- Outer procedure owns the transaction
BEGIN TRANSACTION;
-- First operation in the outer procedure
UPDATE SomeTable SET Column1 = 'Value';
-- Call nested procedure - if it fails, error propagates here
EXEC InnerProcedure;
-- All operations succeeded, commit the transaction
COMMIT TRANSACTION;
END TRY
BEGIN CATCH
-- Outer procedure handles rollback for all nested calls
IF @@TRANCOUNT > 0
ROLLBACK TRANSACTION;
-- Propagate error to the application
THROW;
END CATCH;
END;
GO
CREATE PROCEDURE InnerProcedure
AS
BEGIN
BEGIN TRY
-- Inner procedure does its work within the outer's transaction
UPDATE AnotherTable SET Column2 = 'Value';
END TRY
BEGIN CATCH
-- Don't rollback here - let the outer procedure handle it
-- This keeps transaction management in one place
THROW; -- Re-raise error to outer procedure
END CATCH;
END;
自動ロールバックに XACT_ABORT を使用する
XACT_ABORT ONを設定すると、次のようなTRY...CATCHしなくても、エラーが発生したときに SQL Server によってトランザクションが自動的にロールバックされます。
SET XACT_ABORT ON;
BEGIN TRANSACTION;
UPDATE Table1 SET Col1 = 'A';
UPDATE Table2 SET Col2 = 'B'; -- If this fails, entire transaction rolls back
UPDATE Table3 SET Col3 = 'C';
COMMIT TRANSACTION;
XACT_ABORTとTRY...CATCHを組み合わせると、両方の方法の利点が得られます。XACT_ABORTはエラーの即時ロールバックを保証しますが、TRY...CATCHではエラーの詳細をログに記録し、エラーが伝達される前にカスタム クリーンアップを実行できます。
-- XACT_ABORT ON ensures automatic rollback on any error
SET XACT_ABORT ON;
BEGIN TRY
BEGIN TRANSACTION;
-- Execute multiple procedures as a single unit of work
EXEC Procedure1; -- If any of these fail...
EXEC Procedure2; -- ...XACT_ABORT automatically rolls back...
EXEC Procedure3; -- ...and jumps to the CATCH block
-- All succeeded, commit the changes
COMMIT TRANSACTION;
END TRY
BEGIN CATCH
-- With XACT_ABORT ON, the transaction is usually already rolled back
-- This check handles edge cases where it might still be active
IF @@TRANCOUNT > 0
ROLLBACK TRANSACTION;
-- Log the error details before re-raising
EXEC LogError;
-- Let the caller know an error occurred
THROW;
END CATCH;
ヒント
SET XACT_ABORT ONの使用は、ストアド プロシージャ 、特に複数の操作にまたがるストアド プロシージャのベスト プラクティスです。 これにより、発生した特定のエラーに関係なく、一貫した動作が保証されます。
エラー処理の詳細については、「 TRY..」を参照してください。CATCH (Transact-SQL) と THROW (Transact-SQL)。