チュートリアル: SQL CLR オブジェクトを使用するデータベースプロジェクトを作成して配置する

2011-08-09

SQL Server 共通言語ランタイム (SQL CLR) アセンブリを使用するデータベースを作成して配置するには、データベースプロジェクトと SQL CLR プロジェクトを作成します。データベースプロジェクトをビルドして配置するときに、それが同時に参照する SQL CLR アセンブリが自動的に配置されます。

このチュートリアルでは、次のタスクを行います。

簡単なデータベースプロジェクトを作成する。
SQL CLR プロジェクトを作成して新しいデータ型を定義する。
SQL CLR アセンブリに定義した型を使用する。
データベースプロジェクトをビルドおよび配置する。

必須コンポーネント

このチュートリアルを完了するには、Visual Studio 2010 Premium がインストールされている必要があります。SQL Server 2005 または SQL Server 2008 のインスタンスにアクセスできる必要があります。 SQL Server のコードサンプルは、「CodePlex」Web サイトから入手してインストールする必要があります。データベースをデータベースサーバーに配置するための権限が必要です。

データベースプロジェクトの作成

データベースプロジェクトを作成するには

[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。

[新しいプロジェクト] ダイアログボックスが表示されます。
[インストールされたテンプレート] で、[データベース] ノードを展開し、[SQL Server] ノードをクリックします。

注意

Visual Studio 2010 Professional を使用している場合は、[SQL Server] をクリックする前に、[詳細設定] ノードを展開する必要もあります。
テンプレートの一覧の [SQL Server 2008 データベースプロジェクト] をクリックします。
[名前] ボックスに「SQLClrDatabaseSandbox」と入力します。

重要

[場所] および [ソリューション名] の既定値は変更しないでください。
[ソリューションのディレクトリを作成] チェックボックスがまだオンになっていない場合はオンにします。
[ソース管理に追加] チェックボックスがまだオフになっていない場合はオフにし、[OK] をクリックします。

空のデータベースプロジェクトが、ソリューションエクスプローラーに表示されます。

次に、SQL CLR アセンブリのプロジェクトを作成します。

SQL CLR プロジェクトの作成

SQL CLR プロジェクトを作成するには

[ファイル] メニューの [追加] をポイントし、[プロジェクト] をクリックします。

[新しいプロジェクト] ダイアログボックスが表示されます。
[プロジェクトの種類] の [データベース] ノードを展開し、[SQL Server] をクリックします。
[テンプレート] ボックスの一覧で、[Visual Basic SQL CLR データベースプロジェクト] または [Visual C# SQL CLR データベースプロジェクト] をクリックします。
[名前] ボックスに「SupportingSQLClrObjects」と入力します。
[OK] をクリックして既定の場所をそのまま使用し、ダイアログボックスを閉じて、プロジェクトを作成します。

空のデータベースプロジェクトが、ソリューションエクスプローラーに表示されます。
[データベース参照の追加] ダイアログボックスの [キャンセル] をクリックします。

[キャンセル] をクリックすることにより、アセンブリを配置する場所をデータベースプロジェクトで指定できるようになります。

次に、SQL CLR アセンブリにカスタムデータ型を作成します。

カスタム SQL CLR データ型を定義するには

[プロジェクト] メニューの [ユーザー定義型の追加] をクリックします。

[新しい項目の追加] ダイアログボックスが表示されます。
[名前] ボックスに、「MyCustomType.cs」と入力します。

コードエディターが開き、MyCustomType.cs の内容が表示されます。

注意

この時点で、既定のユーザー定義型を変更して、要件を満たす実装を用意する必要があります。このチュートリアルの場合は、既定の実装をそのまま使用します。ユーザー定義型およびその他の SQL CLR オブジェクトを定義する方法の詳細については、Microsoft Web サイトの「Using CLR Integration in SQL Server 2005 (SQL Server 2005 で CLR 統合を使用する)」を参照してください。
[ファイル] メニューの [MyCustomType.cs の保存] をクリックします。

SQL CLR アセンブリを構成およびビルドするには

[ビルド] メニューの [構成マネージャー] をクリックします。

[構成マネージャー] ダイアログボックスが表示されます。
[プロジェクトのコンテキスト] で、SupportingSQLClrObjects アセンブリの行の [配置] チェックボックスをオフにします。

このチェックボックスをオフにすると、ソリューションを配置するときにアセンブリは配置されません。アセンブリはデータベースプロジェクトと共に配置されるため、アセンブリを 2 回配置する必要はありません。
[閉じる] をクリックします。
ソリューションエクスプローラーで SupportingSQLClrObjects プロジェクトを右クリックし、[ビルド] をクリックします。

アセンブリがエラーを発生することなくビルドされます。

次に、新しいアセンブリを参照し、そのアセンブリに定義した型を使用します。

SQL CLR アセンブリに定義した型の使用

SQCLR アセンブリに定義した型を使用するには、データベースプロジェクトからそのアセンブリに参照を追加する必要があります。その後、オブジェクト定義で新しいデータ型を使用できるように、データベースプロジェクトでデータ型を定義します。

SQL CLR アセンブリの参照を追加するには

ソリューションエクスプローラーで、SQLClrDatabaseSandbox プロジェクトを展開し、[参照設定] ノードを右クリックします。次に、[参照の追加] をクリックします。

注意

ソリューションエクスプローラーで、SQLClrDatabaseSandbox プロジェクトをクリックし、[プロジェクト] メニューを開いて、[参照の追加] をクリックすることもできます。

[参照の追加] ダイアログボックスが表示されます。
[プロジェクト] タブで、SupportingSQLClrObjects プロジェクトが強調表示されていることを確認して、[OK] をクリックします。

SQL CLR プロジェクトへの参照がデータベースプロジェクトに追加されます。
ソリューションエクスプローラーで、[参照] ノードを展開し、[SupportingSQLClrObjects] ノードをクリックして、F4 キーを押します。

参照のプロパティが表示されます。
[ローカルにコピー] が [True] に設定され、[アクセス許可のレベル] が [セーフ] に設定されていることを確認します。
[アセンブリ名] プロパティで、SqlClassLibrary を SupportingSQLClrObjects に置き換えます。
[所有者] プロパティに、「dbo」と入力します。

別の所有者を指定できます。
[ファイル] メニューの [すべてを保存] をクリックします。

指定したプロパティによって、プロジェクトをビルドするときに作成される CREATE ASSEMBLY ステートメントが制御されます。

次に、SQL CLR プロジェクトで生成されるアセンブリを使用するデータ型を定義します。

新しいデータ型を定義するには

[表示] メニューの [エラー一覧] および [データベーススキーマビュー] をクリックします。
[SQLClrDatabaseSandbox] ノード、[スキーマ] ノード、[dbo] ノード、[プログラミング] ノードの順に展開します。
[型] ノードを右クリックし、[追加] をポイントします。次に、[ユーザー定義型 CLR] をクリックします。

[新しい項目の追加] ダイアログボックスが表示されます。
[テンプレート] で、[ユーザー定義型 (CLR)] が強調表示されていることを確認します。
[名前] ボックスに、「MyCustomType」と入力し、[追加] をクリックします。

Transact-SQL エディターが表示され、型の定義が表示されます。 [エラー一覧] ウィンドウに、次のエラーが表示されます。

SR0029 : Microsoft.Validation : User Defined Type: [dbo].[MyCustomType] has an unresolved reference to Assembly [assembly_name]

Transact-SQL エディターで、コードを次のように変更します。

CREATE TYPE [dbo].[MyCustomType]
EXTERNAL NAME [SupportingSQLClrObjects].[MyCustomType]

[ファイル] メニューの [MyCustomType.udtclr.sql の保存] をクリックします。

有効なアセンブリとクラスを参照する型定義を更新したため、[エラー一覧] ウィンドウのエラーの表示が消えます。

次に、新しいデータ型を使用する簡単なテーブルを定義します。

テーブル定義で新しいデータ型を使用するには

[スキーマビュー] で、[スキーマ] ノードを開き、[dbo] ノードを開きます。
[テーブル] ノードを右クリックし、[追加] をポイントします。次に、[テーブル] をクリックします。

[新しい項目の追加] ダイアログボックスが表示されます。
[テンプレート] で、[テーブル] が強調表示されていることを確認します。
[名前] ボックスに、「SimpleTable」と入力し、[追加] をクリックします。

Transact-SQL エディターが表示され、テーブルの定義が表示されます。

Transact-SQL エディターで、コードを次のように変更します。

CREATE TABLE [dbo].[SimpleTable]
(
column_1 int NOT NULL, 
column_2 [dbo].[MyCustomType] NULL
)

[ファイル] メニューの [dbo.SimpleTable.table.sql の保存] をクリックします。

次に、データベースプロジェクトを構成し、それを分離開発環境に配置します。

データベースプロジェクトのビルドおよび配置

ビルド設定を構成するには

ソリューションエクスプローラーで、[SQLClrDatabaseSandbox] をクリックします。
[プロジェクト] メニューの [SQLClrDatabaseSandbox のプロパティ] をクリックします。
[ビルド] タブをクリックし、既定の設定を確認します。

このチュートリアルでは、既定の設定を使用できます。

次に、配置設定を構成します。

配置設定を構成するには

[配置] タブをクリックします。
[配置動作] ボックスの一覧の [配置スクリプト (.sql) を作成してデータベースに配置します] をクリックします。
[配置設定の構成] (配置設定の構成) ボックスの一覧の [マイ分離開発環境] をクリックします。

この設定を指定することで、分離開発環境にのみ影響する値を構成します。データベースプロジェクトの設定は変更しません。
[配置スクリプト名] については、既定値をそのまま使用します。
[ターゲットデータベースの設定] の [編集] をクリックし、ターゲット接続を指定します。
[接続のプロパティ] ダイアログボックスで、データベースプロジェクトを配置するサーバーおよびデータベースへの接続を指定し、[OK] をクリックします。
[ターゲットデータベース名] については、既定値をそのまま使用します。
[配置構成ファイル] ボックスの一覧の [Properties\Database.deploymentconfig] をクリックします。

既定では、分離開発環境は、配置設定の詳細設定には関連付けられていません。このファイルを指定すると、データベースプロジェクトに関連付けられた配置設定が使用されます。また、別の構成ファイルを作成し、分離開発環境用に設定を変更することもできます。
[SQL コマンド変数ファイル] ボックスの一覧の [Properties\Database.sqlcmdvars] をクリックします。
[ファイル] メニューの [すべてを保存] をクリックします。

次に、データベースプロジェクトをビルドします。

データベースプロジェクトをビルドおよび配置するには

[ビルド] メニューの [ソリューションのビルド] をクリックします。

データベースプロジェクトと SQL CLR アセンブリプロジェクトが正常にビルドされます。
[ビルド] メニューの [ソリューションの配置] をクリックします。

データベースプロジェクトと SQL CLR アセンブリが、配置設定で指定したターゲットサーバーとデータベースに配置されます。 [出力] ウィンドウに次のメッセージが表示されます。

========== 配置: 1 正常終了、0 失敗、0 スキップ ==========

これで、データベースプロジェクトが正常に配置されました。データベースプロジェクトを配置したときに、SQL CLR アセンブリも配置しました。 SQL CLR アセンブリを別個に配置する必要はありませんでした。これは、ソリューションを配置したときにスキップされたためです。

プロジェクトのチームでの利用 (省略可能)

プロジェクトをバージョン管理に追加するには

ソリューションエクスプローラーで、[SQLClrDatabaseSandbox] ノードをクリックします。
[ファイル] メニューの [ソース管理] をポイントし、[ソリューションをソース管理に追加] をクリックします。

ここで、インストール済みのバージョン管理ソフトウェアを使用して操作します。このチュートリアルでは、Visual Studio Team Foundation Server にプロジェクトを追加する手順について説明します。異なるバージョン管理ソフトウェアを使用する場合、同等の手順を実行してください。 Team Foundation Server を使用している場合は、[Team Foundation Server に接続] ダイアログボックスが表示されます。
[Team Foundation Server に接続] で、ソリューションを追加するチームプロジェクトをホストしているサーバーをクリックします。

注意

データベースプロジェクトを追加できるチームプロジェクトがない場合は、「プロジェクトの計画および追跡」を参照してください。
[チームプロジェクト] で、データベースプロジェクトを追加するチームプロジェクトをクリックし、[OK] をクリックします。

[ソリューション SQLClrDatabaseSandbox をソース管理に追加] ダイアログボックスが表示されます。
[OK] をクリックして既定値を受け入れます。

データベースプロジェクトおよびそれを格納するファイルがバージョン管理されます。最初は、それらはまだチェックアウトされています。他のチームメンバーがアクセスする前にチェックインする必要があります。
[表示] メニューの [その他のウィンドウ] をポイントし、[保留中の変更] をクリックします。

[保留中の変更] ウィンドウが表示されます。
[コメント] ボックスに、「Initial database project creation」と入力します。
[保留中の変更] ウィンドウで、ツールバーの [チェックイン] をクリックします。

データベースプロジェクトおよびそれに含まれているファイルがチェックインされるときに、[チェックインの進行状況] ダイアログボックスが表示されます。 ソリューションエクスプローラー内でアイコンが変わり、ファイルがバージョン管理にチェックインされたことを示します。

次の手順

次に、データベース単体テストとデータ生成計画を作成して、アセンブリをテストできます。詳細については、「データベースプロジェクトの構成とテスト配置の実行」を参照してください。

参照

概念

データベースのチーム開発の開始

他のデータベースを参照するデータベースのチーム開発の開始

SQLCLR オブジェクトを参照するデータベースのチーム開発の開始

共有サーバーオブジェクトを参照するデータベースのチーム開発の開始

Visual Studio のデータベース機能に必要なアクセス許可