手順 4:ADO.NET で SQL に弾性的に接続する

[アーティクル]
05/23/2023

前の記事:手順 3: ADO.NET を使用した SQL への接続を概念実証する

このトピックでは、カスタムの再試行ロジックを示す C# コードサンプルを提供します。再試行ロジックによって信頼性が高まります。この再試行ロジックは、プログラムが数秒間待機して再試行すると解消する傾向がある一時的なエラーや一時的な障害を適切に処理することを目的としています。

一時的な障害の原因には、次のものがあります。

インターネットをサポートするネットワークの短時間の障害。
クエリが送信された時点で、クラウドシステムがリソースの負荷分散を行っている可能性があります。

ローカル Microsoft SQL Server に接続するための ADO.NET クラスでは、Azure SQL Database に接続することもできます。ただし、ADO.NET クラス自体で、運用環境での使用に必要な堅牢性と信頼性がすべて提供されるわけではありません。クライアントプログラムで一時的な障害が発生しても、そこから通知なしに正常に回復し、処理を続行できる場合があります。

手順 1:一時的なエラーを識別する

プログラムでは、一時的なエラーと永続的なエラーを区別する必要があります。一時的なエラーとは、一時的なネットワークの問題など、短期間で解消する可能性のあるエラー状態です。永続的なエラーの例として、プログラムにターゲットデータベース名のスペルミスが含まれており (この場合は、"そのようなデータベースは見つかりません" というエラーがいつまでも表示されます)、短期間で解消される見込みがない場合が考えられます。

一時的な障害として分類されるエラー番号の一覧は、SQL Database クライアントアプリケーションのエラーメッセージに関するページに記載されています。

手順 2:サンプルアプリケーションを作成して実行する

このサンプルは、.NET Framework 4.6.2 以降がインストールされていることを前提としています。 C# のコードサンプルは、Program.cs という名前の 1 つのファイルで構成されます。次のセクションでコードについて説明します。

手順 2.a: サンプルコードをキャプチャしてコンパイルする

次の手順で、サンプルをコンパイルができます。

無料の Visual Studio Community edition、C# コンソールアプリケーションテンプレートから新しいプロジェクトを作成します。
- [ファイル] > [新規作成] > [プロジェクト] > [インストール済み] > [テンプレート] > [Visual C#] > [Windows] > [従来のデスクトップ] > [コンソールアプリケーション] の順にクリックします。
- プロジェクトに、「 RetryAdo2」という名前を付けます。
[ソリューションエクスプローラー] ペインを開きます。
- プロジェクトの名前を確認します。
- プロジェクトで、Microsoft.Data.SqlClient パッケージに NuGet の依存関係を追加します。
- Program.cs ファイルの名前を確認します。
Program.cs ファイルを開きます。
Program.cs ファイルの内容全体を次のコードブロックのコードに置き換えます。
メニューで [ビルド] > [ソリューションのビルド] の順にクリックします。

手順 2.b: サンプルコードをコピーして貼り付ける

このコードを、 Program.cs ファイルに貼り付けます。

次にサーバー名、パスワードなどの文字列を編集する必要があります。これらの文字列は、GetSqlConnectionString という名前のメソッドにあります。

注:このサーバー名の接続文字列には tcp: の 4 文字のプレフィックスが含まれているため、Azure SQL Database 向けになっています。ただし、このサーバー文字列は、Microsoft SQL Server に接続するように調整することができます。

using System;
using System.Collections.Generic;
using Microsoft.Data.SqlClient;
using System.Threading;

namespace RetryAdo2; 

public class Program
{
    public static int Main(string[] args)
    {
        bool succeeded = false;
        const int totalNumberOfTimesToTry = 4;
        int retryIntervalSeconds    = 10;

        for (int tries = 1; tries <= totalNumberOfTimesToTry; tries++)
        {
            try
            {
                if (tries > 1)
                {
                    Console.WriteLine(
                        "Transient error encountered. Will begin attempt number {0} of {1} max...",
                        tries,
                        totalNumberOfTimesToTry
                    );
                    Thread.Sleep(1000 * retryIntervalSeconds);
                    retryIntervalSeconds = Convert.ToInt32(retryIntervalSeconds * 1.5);
                }
                AccessDatabase();
                succeeded = true;
                break;
            }
            catch (SqlException sqlExc) {
                if (TransientErrorNumbers.Contains(sqlExc.Number))
                {
                    Console.WriteLine("{0}: transient occurred.", sqlExc.Number);
                    continue;
                }

                Console.WriteLine(sqlExc);
                succeeded = false;
                break;
            }
            catch (TestSqlException sqlExc) {
                if (TransientErrorNumbers.Contains(sqlExc.Number))
                {
                    Console.WriteLine("{0}: transient occurred. (TESTING.)", sqlExc.Number);
                    continue;
                }

                Console.WriteLine(sqlExc);
                succeeded = false;
                break;
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
                succeeded = false;
                break;
            }
        }

        if (!succeeded) {
            Console.WriteLine("ERROR: Unable to access the database!");
            return 1;
        }

        return 0;
    }

    /// <summary>
    /// Connects to the database, reads,
    /// prints results to the console.
    /// </summary>
    static void AccessDatabase() {
        //throw new TestSqlException(4060); //(7654321);  // Uncomment for testing.

        using var sqlConnection = new SqlConnection(GetSqlConnectionString());

        using var dbCommand = sqlConnection.CreateCommand();

        dbCommand.CommandText =
            @"  
SELECT TOP 3  
	ob.name,  
	CAST(ob.object_id as nvarchar(32)) as [object_id]  
  FROM sys.objects as ob  
  WHERE ob.type='IT'  
  ORDER BY ob.name;";

        sqlConnection.Open();
        var dataReader = dbCommand.ExecuteReader();

        while (dataReader.Read())
        {
            Console.WriteLine(
                "{0}\t{1}",
                dataReader.GetString(0),
                dataReader.GetString(1)
            );
        }
    }

    /// <summary>
    /// You must edit the four 'my' string values.
    /// </summary>
    /// <returns>An ADO.NET connection string.</returns>
    static private string GetSqlConnectionString()
    {
        // Prepare the connection string to Azure SQL Database.
        var sqlConnectionSB = new SqlConnectionStringBuilder 
        {
            // Change these values to your values.
            DataSource           = "tcp:myazuresqldbserver.database.windows.net,1433", //["Server"]
            InitialCatalog       = "MyDatabase",                                       //["Database"]
            UserID               = "MyLogin",                                          // "@yourservername"  as suffix sometimes.
            Password             = "MyPassword",
            // Adjust these values if you like. (ADO.NET 4.5.1 or later.)
            ConnectRetryCount    = 3,
            ConnectRetryInterval = 10, // Seconds.
            // Leave these values as they are.
            IntegratedSecurity = false,
            Encrypt            = true,
            ConnectTimeout     = 30
        };

        return sqlConnectionSB.ToString();
    }

    static List<int> TransientErrorNumbers = new() 
    {
        4060, 40197, 40501, 40613, 49918, 49919, 49920, 11001
    };
}

/// <summary>
/// For testing retry logic, you can have method
/// AccessDatabase start by throwing a new
/// TestSqlException with a Number that does
/// or does not match a transient error number
/// present in TransientErrorNumbers.
/// </summary>
internal class TestSqlException : ApplicationException
{
    internal TestSqlException(int testErrorNumber)
    {
        Number = testErrorNumber;
    }

    internal int Number { get; set; }
}

手順 2.c: プログラムの実行

RetryAdo2.exe 実行可能ファイルにはパラメーターを入力しません。 .exe ファイルを実行するには、次のようにします。

RetryAdo2.exe バイナリをコンパイルした場所にコンソールウィンドウを開きます。
入力パラメーターなしで RetryAdo2.exe を実行します。

database_firewall_rules_table   245575913  
filestream_tombstone_2073058421 2073058421  
filetable_updates_2105058535    2105058535

手順 3:再試行ロジックをテストする方法

一時的なエラーをシミュレートして再試行ロジックをテストするには、いくつかの方法があります。

手順 3.a: テスト例外をスローする

コードサンプルには、以下のものが含まれています。

Number という名前のプロパティを含む、TestSqlException という名前の小さな 2 番目のクラス。
//throw new TestSqlException(4060); のコメントを解除できます。

throw ステートメントのコメントを解除して再コンパイルすると、RetryAdo2.exe の次回の実行によって次のような行が出力されます。

[C:\VS15\RetryAdo2\RetryAdo2\bin\Debug\]  
>> RetryAdo2.exe  
4060: transient occurred. (TESTING.)  
Transient error encountered. Will begin attempt number 2 of 4 max...  
4060: transient occurred. (TESTING.)  
Transient error encountered. Will begin attempt number 3 of 4 max...  
4060: transient occurred. (TESTING.)  
Transient error encountered. Will begin attempt number 4 of 4 max...  
4060: transient occurred. (TESTING.)  
ERROR: Unable to access the database!  
  
[C:\VS15\RetryAdo2\RetryAdo2\bin\Debug\]  
>>

手順 3.b: 永続的なエラーで再テストする

コードが永続的なエラーを適切に処理できることを確かめるには、前のテストを再実行します。ただし、4060 などの実際の一時的なエラーの番号は使用しないでください。代わりに、意味のない番号 7654321 を使用します。プログラムはこれを永続的なエラーとして扱い、再試行をすべてバイパスするはずです。

手順 3.c: ネットワークから切断する

クライアントコンピューターをネットワークから切断します。
- デスクトップの場合、ネットワークケーブルを外します。
- ラップトップの場合、ファンクションキーの組み合わせを押してネットワークアダプターをオフにします。
RetryAdo2.exe を起動し、最初の一時的なエラーがコンソールに表示されるのを待ちます (おそらく 11001)。
RetryAdo2.exe が実行している間に、ネットワークに再接続します。
続いて行われる再試行が成功したことをコンソールで確認します。

手順 3.d: 一時的にスペルミスのあるサーバー名を使用する

一時的に 40615 を別のエラー番号として TransientErrorNumbersに追加し、再コンパイルします。
new QC.SqlConnectionStringBuilder()の行にブレークポイントを設定します。
[エディットコンティニュ] 機能を使用して、数行下で意図的にサーバー名のスペルを間違えます。
- プログラムを実行し、ブレークポイントに戻ります。
- 40615 エラーが発生します。
スペルミスを修正します。
プログラムを実行すると正常に終了します。
40615 を削除し、再コンパイルします。

次のステップ

他のベストプラクティスおよびデザインガイドラインを調べるには、SQL Database への接続: リンク、ベストプラクティスおよびデザインガイドラインに関するページを参照してください。

次の方法で共有

手順 4:ADO.NET で SQL に弾性的に接続する

手順 1:一時的なエラーを識別する

手順 2:サンプルアプリケーションを作成して実行する

手順 2.a: サンプルコードをキャプチャしてコンパイルする

手順 2.b: サンプルコードをコピーして貼り付ける

手順 2.c: プログラムの実行

手順 3:再試行ロジックをテストする方法

手順 3.a: テスト例外をスローする

手順 3.b: 永続的なエラーで再テストする

手順 3.c: ネットワークから切断する

手順 3.d: 一時的にスペルミスのあるサーバー名を使用する

次のステップ

フィードバック

その他のリソース

次の方法で共有

手順 4:ADO.NET で SQL に弾性的に接続する

手順 1:一時的なエラーを識別する

手順 2:サンプル アプリケーションを作成して実行する

手順 2.a: サンプル コードをキャプチャしてコンパイルする

手順 2.b: サンプル コードをコピーして貼り付ける

手順 2.c: プログラムの実行

手順 3:再試行ロジックをテストする方法

手順 3.a: テスト例外をスローする

手順 3.b: 永続的なエラーで再テストする

手順 3.c: ネットワークから切断する

手順 3.d: 一時的にスペルミスのあるサーバー名を使用する

次のステップ

フィードバック

その他のリソース

手順 2:サンプルアプリケーションを作成して実行する

手順 2.a: サンプルコードをキャプチャしてコンパイルする

手順 2.b: サンプルコードをコピーして貼り付ける