SQL Serverにおけるエラー処理のベストプラクティス：RAISERROR()の使い方から応用例まで

SQL Server における RAISERROR() の構文と意味

構文

RAISERROR(
    msg_id,       /* エラー メッセージ ID またはメッセージ文字列  */
    severity,     /* エラーの重大度 (11 ～ 25)  */
    state,        /* エラー状態 (0 ～ 255)  */
    [message text], /* エラー メッセージ テキスト (省略可能)  */
    [argument1],   /* エラー メッセージ置換パラメーター (最大 21)  */
    ...
);

パラメーター

• msg_id: エラー メッセージ ID またはメッセージ文字列。メッセージ ID を指定する場合は、sys.messages カタログ ビューに定義されている必要があります。メッセージ文字列を指定する場合は、引用符で囲む必要があります。
• severity: エラーの重大度。11 ～ 25 の値を指定できます。値が 11 ～ 16 の場合は、エラーが報告されますが、トランザクションは続行されます。値が 17 ～ 20 の場合は、エラーが報告され、トランザクションがロールバックされます。値が 21 ～ 25 の場合は、エラーが報告され、トランザクションがロールバックされ、セッションが終了します。
• state: エラー状態。0 ～ 255 の値を指定できます。このパラメーターは、通常使用されません。
• message text: エラー メッセージ テキスト (省略可能)。メッセージ ID を指定する場合にのみ使用できます。メッセージ テキストには、置換パラメーターを含めることができます。
• argument1: エラー メッセージ置換パラメーター (最大 21)。置換パラメーターは、@ 記号で指定します。

例

-- エラー メッセージ ID 5000 を使用してエラーを報告する
RAISERROR(5000, 16, 1, 'データベース接続に失敗しました。');

-- メッセージ文字列を使用してエラーを報告する
RAISERROR('無効なユーザー ID またはパスワードです。', 18, 1);

-- 置換パラメーターを使用してエラー メッセージを生成する
RAISERROR(5001, 16, 1, 'テーブル "%s" は存在しません。', @TableName);

RAISERROR() と THROW の違い

RAISERROR() と THROW は、どちらも Transact-SQL でエラーを処理するために使用されるステートメントですが、いくつかの重要な違いがあります。

• エラー処理: RAISERROR() は、エラー メッセージを生成し、セッションのエラー処理を開始します。一方、THROW は、エラー メッセージを生成せずに例外をスローします。
• トランザクションのロールバック: RAISERROR() は、severity パラメーターの値に応じて、トランザクションをロールバックするかどうかを決定します。一方、THROW は、常にトランザクションをロールバックします。
• CATCH ブロック: RAISERROR() で生成されたエラーは、CATCH ブロックで処理できます。一方、THROW でスローされた例外は、CATCH ブロックで処理できるとは限りません。

この例では、RAISERROR() ステートメントを使用して、エラー メッセージ ID 5000 を使用してエラーを報告します。

CREATE PROCEDURE sp_CreateUser
(
    @UserName nvarchar(50),
    @Password nvarchar(50)
)
AS
BEGIN
    DECLARE @UserId int;

    -- ユーザーを作成する
    INSERT INTO Users (UserName, Password)
    VALUES (@UserName, @Password);

    -- ユーザー ID を取得する
    SELECT @UserId = SCOPE_IDENTITY();

    -- ユーザー ID が 0 の場合は、エラーを報告する
    IF @UserId = 0
    BEGIN
        RAISERROR(5000, 16, 1, 'ユーザーの作成に失敗しました。');
        RETURN;
    END

    -- 成功メッセージを返す
    RAISERROR('ユーザー "%s" が作成されました。', 11, 1, @UserName);
END;

このコードを実行すると、次の出力が生成されます。

ユーザー "John Doe" が作成されました。

CREATE PROCEDURE sp_DeleteUser
(
    @UserId int
)
AS
BEGIN
    -- ユーザーが存在するかどうかを確認する
    IF NOT EXISTS (SELECT 1 FROM Users WHERE UserId = @UserId)
    BEGIN
        RAISERROR('ユーザー ID "%d" のユーザーは存在しません。', 18, 1, @UserId);
        RETURN;
    END

    -- ユーザーを削除する
    DELETE FROM Users WHERE UserId = @UserId;

    -- 成功メッセージを返す
    RAISERROR('ユーザー ID "%d" のユーザーが削除されました。', 11, 1, @UserId);
END;

ユーザー ID "1" のユーザーが削除されました。

例 3: 置換パラメーターを使用してエラー メッセージを生成する

CREATE PROCEDURE sp_UpdatePassword
(
    @UserId int,
    @NewPassword nvarchar(50)
)
AS
BEGIN
    -- パスワードが 6 文字未満の場合は、エラーを報告する
    IF LEN(@NewPassword) < 6
    BEGIN
        RAISERROR('パスワードは 6 文字以上である必要があります。', 18, 1, @NewPassword);
        RETURN;
    END

    -- パスワードを更新する
    UPDATE Users
    SET Password = @NewPassword
    WHERE UserId = @UserId;

    -- 成功メッセージを返す
    RAISERROR('ユーザー ID "%d" のパスワードが更新されました。', 11, 1, @UserId);
END;

ユーザー ID "1" のパスワードが更新されました。

RAISERROR() の代替方法

THROW

THROW は、Transact-SQL で例外をスローするために使用されるステートメントです。RAISERROR() に比べて以下の利点があります。

• 簡潔: THROW は RAISERROR() よりも簡潔で、コードを読みやすくすることができます。
• エラー処理ロジックの明確化: THROW は、エラー処理ロジックをより明確にすることができます。
• .NET Framework との互換性: THROW は .NET Framework と互換性があり、.NET Framework を使用するアプリケーションとの統合が容易になります。

ただし、THROW には RAISERROR() と比べて以下の欠点もあります。

• トランザクションのロールバック: THROW は常にトランザクションをロールバックする一方、RAISERROR() は severity パラメーターの値に応じてトランザクションをロールバックするかどうかを決定することができます。
• CATCH ブロック: THROW でスローされた例外は、CATCH ブロックで処理できるとは限りません。一方、RAISERROR() で生成されたエラーは、CATCH ブロックで処理できます。

例:

CREATE PROCEDURE sp_CreateUser
(
    @UserName nvarchar(50),
    @Password nvarchar(50)
)
AS
BEGIN
    DECLARE @UserId int;

    -- ユーザーを作成する
    INSERT INTO Users (UserName, Password)
    VALUES (@UserName, @Password);

    -- ユーザー ID を取得する
    SELECT @UserId = SCOPE_IDENTITY();

    -- ユーザー ID が 0 の場合は、例外をスローする
    IF @UserId = 0
    BEGIN
        THROW 5000, 16, 1, 'ユーザーの作成に失敗しました。';
    END

    -- 成功メッセージを返す
    RAISERROR('ユーザー "%s" が作成されました。', 11, 1, @UserName);
END;

SIGNALER

SIGNER は、Transact-SQL でシグナルを発生させるために使用されるステートメントです。THROW に似ていますが、以下の点が異なります。

• シグナルの種類: SIGNALER は、事前定義されたシグナルの種類を指定する必要があります。一方、THROW は、任意のエラー メッセージを指定することができます。
• エラー処理ロジック: SIGNALER は、エラー処理ロジックをより詳細に制御することができます。

SIGNER は、複雑なエラー処理ロジックが必要な場合に役立ちます。ただし、THROW に比べて複雑で、習得するのが難しいという欠点があります。

CREATE PROCEDURE sp_CreateUser
(
    @UserName nvarchar(50),
    @Password nvarchar(50)
)
AS
BEGIN
    DECLARE @UserId int;

    -- ユーザーを作成する
    INSERT INTO Users (UserName, Password)
    VALUES (@UserName, @Password);

    -- ユーザー ID を取得する
    SELECT @UserId = SCOPE_IDENTITY();

    -- ユーザー ID が 0 の場合は、シグナルを発生させる
    IF @UserId = 0
    BEGIN
        SIGNALEVENT('CreateUserFailed');
    END

    -- 成功メッセージを返す
    RAISERROR('ユーザー "%s" が作成されました。', 11, 1, @UserName);
END;

BEGIN...CATCH...END ブロック

BEGIN...CATCH...END ブロックは、Transact-SQL でエラーを処理するために使用される構文です。RAISERROR() や THROW を使用するよりも、より構造化された方法でエラーを処理することができます。

BEGIN...CATCH...END ブロックは、複数の CATCH ブロックを含めることができ、それぞれ異なる種類のエラーを処理することができます。また、FINALLY ブロックを使用して、エラーが発生したかどうかにかかわらず、常に実行されるコードを記述することもできます。

BEGIN...CATCH...END ブロックは、複雑なエラー処理ロジックが必要な場合に役立ちます。ただし、THROW や SIGNALER に比べて冗長で、コードを読みづらくする可能性があります。

CREATE PROCEDURE sp_CreateUser
(
    @UserName nvarchar(50),
    @Password nvarchar(50)
)
AS
BEGIN
    DECLARE @UserId int;

    -- ユーザーを作成する
    BEGIN TRANSACTION;

    INSERT INTO Users (UserName, Password)
    VALUES (@UserName, @Password);

    -- ユーザー ID を取得する
    SELECT @UserId = SCOPE_IDENTITY();