CLR データベースオブジェクトをデバッグする方法

[アーティクル]
08/30/2023

適用対象 SQL Server

SQL Server は、データベース内の Transact-SQL オブジェクトおよび共通言語ランタイム (CLR) オブジェクトのデバッグをサポートしています。 SQL Server でのデバッグの重要な特徴は、セットアップと使用が容易になったことと、SQL Server デバッガーと Microsoft Visual Studio デバッガーが統合されたことです。さらに、複数の言語にまたがったデバッグを実行できます。ユーザーは Transact-SQL から CLR オブジェクト (またはその逆) にシームレスにステップインできます。 SQL Server Management Studio の Transact-SQL デバッガーを使用してマネージドデータベースオブジェクトをデバッグすることはできませんが、Visual Studio のデバッガーを使用すると、このオブジェクトをデバッグすることができます。 Visual Studio でのマネージドデータベースオブジェクトのデバッグでは、サーバーで実行するルーチン内の "step into" ステートメントや "step over" ステートメントなど、一般的なデバッグ機能すべてがサポートされます。デバッグ中は、ブレークポイントの設定、呼び出し履歴の調査、変数の調査、変数値の変更を行うことができます。

Note

Visual Studio .NET 2003 は、CLR 統合プログラミングまたはデバッグには使用できません。 SQL Server には .NET Framework がプレインストールされていますが、Visual Studio .NET 2003 では .NET Framework 2.0 アセンブリを使用できません。

デバッグに関する権限と制限事項

デバッグは高度な特権が必要な操作であるため、SQL Server でデバッグを行うことができるのは、sysadmin 固定サーバーロールのメンバーのみです。

デバッグ中には、次の制限事項が適用されます。

CLR ルーチンを同時にデバッグできるデバッガーインスタンスは 1 つに制限されます。この制限が適用されるのは、ブレークポイントに到達するとすべての CLR コードの実行が停止し、デバッガーがブレークポイントから先に動作を進めるまで、コードの実行を再開できないことが理由です。ただし、他の接続での Transact-SQL のデバッグは続行できます。 Transact-SQL のデバッグによりサーバーの他の実行が停止することはありませんが、デバッグがロックをかけると、他の接続が待機することになる場合があります。
デバッグできるのは、既存の接続ではなく新しい接続のみです。これは、SQL Server が、接続が行われる前のクライアントとデバッガーの環境に関する情報を必要とするためです。

Transact-SQL コードと CLR コードのデバッグは、上記の制限事項により、実稼働サーバーではなくテストサーバーで行うことをお勧めします。

概要

Transact-SQL のデバッグは、接続ごとのモデルに準拠します。デバッガーは、デバッガーがアタッチされているクライアント接続のみに関係したアクティビティを検出してデバッグを実行することができます。デバッガーの機能は、接続の種類による制限を受けないので、表形式のデータストリーム (TDS) 接続と HTTP 接続の両方をデバッグできます。ただし、SQL Server では、既存の接続をデバッグできません。デバッグでは、サーバーで実行するルーチン内のすべての一般的なデバッグ機能をサポートします。デバッガーと SQL Server との間のやり取りは、分散 COM (コンポーネントオブジェクトモデル) 経由で行われます。

マネージドストアドプロシージャ、関数、トリガー、ユーザー定義型、集計のデバッグの詳細とシナリオについては、Visual Studio ドキュメントの「SQL Server CLR 統合データベースのデバッグ」を参照してください。

Visual Studio を使用してリモート開発、デバッグおよび開発を行うには、SQL Server インスタンスで TCP/IP ネットワークプロトコルを有効にする必要があります。サーバーで TCP/IP プロトコルを有効にする方法の詳細については、「クライアントプロトコルの構成」を参照してください。

デバッグ手順

Microsoft Visual Studio で CLR データベースオブジェクトをデバッグするには、次の手順に従います。

Microsoft Visual Studio を開き、 [新しい SQL Server プロジェクトの作成] を選択します。 Visual Studio に付属する SQL LocalDB インスタンスを使用できます。
新しい SQL CLR 型の作成 (C#):
1. ソリューションエクスプローラーでプロジェクトを右クリックして、[追加]、[新しい項目...] を選択します。
2. [新しい項目の追加]ウィンドウで、SQL CLR C# ストアドプロシージャ、SQL CLR C# ユーザー定義関数、SQL CLR C# ユーザー定義型、SQL CLR C# トリガー、SQL CLR C# 集計、またはクラスを選択します。
3. 新しい種類のソースファイルの名前を指定し、[追加] を選択します。
テキストエディターに新しい型のコードを追加します。ストアドプロシージャの例のサンプルコードについては、この記事の次の「例」のセクションを参照してください。
型をテストするスクリプトを追加します。
1. ソリューションエクスプローラーで、プロジェクトノードを右クリックして、[追加]、[スクリプト...] を選択します。
2. [新しい項目の追加] ウィンドウで、[スクリプト] (ビルド内ではない) を選択し、Test.sql などの名前を指定します。追加ボタンを選択します。
3. ソリューションエクスプローラーで、Test.sql ノードをダブルクリックして、既定のテストスクリプトソースファイルを開きます。
4. テストスクリプト（デバッグするコードを呼び出すスクリプト）をテキストエディターに追加します。サンプルスクリプトについては、次のセクションの例を参照してください。
ソースコードに 1 つ以上のブレークポイントを配置します。デバッグする関数またはルーチンのテキストエディターで、コード行を右クリックします。 [ブレークポイント]、[ブレークポイントの挿入] の順に選択します。ブレークポイントが追加され、コード行が赤で強調表示されます。
[デバッグ] メニューの [デバッグの開始] を選択して、プロジェクトをコンパイル、デプロイ、およびテストします。 Test.sql の Test.sql のテストスクリプトが実行され、マネージドデータベースオブジェクトが呼び出されます。
黄色い矢印 (命令ポインターを表す) がブレークポイントに表示されると、コードの実行が一時停止されます。その後、マネージドデータベースオブジェクトをデバッグできます。
1. [デバッグ] メニューから ステップオーバー を使用して、命令ポインターを次のコード行に進めます。
2. [ローカル] ウィンドウを使用して、命令ポインターによって現在強調表示されているオブジェクトの状態を確認します。
3. ウォッチ ウィンドウに変数を追加します。監視される変数の状態は、変数が命令ポインターにより現在強調表示されているコード行にないときでも、デバッグセッション全体で見ることができます。
4. [デバッグ] メニューの [続行] を選択し、命令ポインターを次のブレークポイントに進めるか、ブレークポイントがこれ以上ない場合にはルーチンの実行を完了します。

コード例

次の例では、SQL Server のバージョンを呼び出し元に返します。

using System.Data.SqlClient;
using Microsoft.SqlServer.Server;

public class StoredProcedures
{
    [Microsoft.SqlServer.Server.SqlProcedure]
    public static void GetVersion()
    {
        using (var connection = new SqlConnection("context connection=true"))
        {
            connection.Open();
            var command = new SqlCommand("select @@version", connection);
            SqlContext.Pipe.ExecuteAndSend(command);
        }
    }
}

テストスクリプトの例

次のテストスクリプトは、前の例で定義した GetVersion ストアドプロシージャを呼び出す方法を示しています。

EXEC GetVersion

次のステップ

Visual Studio を使用したマネージドコードのデバッグの詳細については、Visual Studio のドキュメントで「マネージドコードのデバッグ」を参照してください。

詳細については、「共通言語ランタイム統合のプログラミング概念」を参照してください

次の方法で共有

CLR データベースオブジェクトをデバッグする方法

デバッグに関する権限と制限事項

概要

デバッグ手順

コード例

テストスクリプトの例

次のステップ

フィードバック

その他のリソース

次の方法で共有

CLR データベース オブジェクトをデバッグする方法

デバッグに関する権限と制限事項

概要

デバッグ手順

コード例

テストスクリプトの例

次のステップ

フィードバック

その他のリソース

CLR データベースオブジェクトをデバッグする方法