チュートリアル: カスタムデータジェネレーターの作成

[アーティクル]
08/15/2011

データベーススキーマを開発するとき、できる限り本番データに近いデータを使用してテストデータベースを作成することで、提示された変更を、より効果的にテストできます。カスタムデータジェネレーターは、組み込みのデータジェネレーターよりも厳密に仕様を満たすテストデータを提供します。たとえば、指定したリストからランダムな文字列を使用したり、指定した範囲内の数字を使用したりして、テーブルの列にデータを読み込むジェネレーターを作成できます。詳細については、「データジェネレーター機能拡張の概要」を参照してください。

このトピックでは、ランダムな住所文字列を生成するカスタムデータジェネレーターを作成する方法を手順に沿って説明します。このチュートリアルでは、次のタスクを行います。

Generator を継承する、カスタム住所データジェネレーターのクラスライブラリを作成します。
ジェネレーター出力として使用する出力プロパティを追加します。
OnGenerateNextValues メソッドをオーバーライドして、データを生成します。
ジェネレーターアセンブリに署名します。
アセンブリに関連付けられた登録用の XML ファイルを作成します。
カスタムデータジェネレーターをテストするためのデータベースプロジェクトとデータ生成計画を作成します。

必須コンポーネント

このチュートリアルを完了するには、Visual Studio Premium または Visual Studio Ultimate がインストールされている必要があります。

カスタムジェネレーターのクラスライブラリの作成

まず、カスタム住所データジェネレーターのクラスライブラリを作成します。

カスタムジェネレーターのクラスライブラリを作成するには

Visual C# クラスライブラリプロジェクトを作成し、SampleGenerator という名前を付けます。
ソリューションエクスプローラーで、プロジェクトを右クリックし、[参照の追加] をクリックします。
[.NET] タブをクリックします。
[コンポーネント名] 列で、次のコンポーネントを選択します。
- Microsoft.Data.Schema
- Microsoft.Data.Schema.Sql
- Microsoft.Data.Schema.Tools
ヒント

複数のコンポーネントを選択するには、Ctrl キーを押しながらコンポーネントをクリックします。
必要なすべてのコンポーネントを選択したら、[OK] をクリックします。

ソリューションエクスプローラーで、選択された参照がプロジェクトの [参照設定] ノードに表示されます。

[コード] ウィンドウの一番上のクラス宣言の前に、次のコード行を追加します。

using Microsoft.Data.Schema.Tools.DataGenerator;
using Microsoft.Data.Schema.Extensibility;
using Microsoft.Data.Schema;
using Microsoft.Data.Schema.Sql;

クラス名を Class1 から AddressGenerator に変更します。

ヒント

既定では、クラス名として指定した名前は、[列の詳細] ウィンドウの [ジェネレーター] 列の一覧に表示されます。組み込みのジェネレーターや他のカスタムジェネレーターの名前と競合しない名前を指定してください。
```
public class AddressGenerator
{
}
```
次の例に示すように、Generator からのクラスの継承を指定します。
```
public class AddressGenerator : Generator
{
}
```
次の例に示すように、DatabaseSchemaProviderCompatibilityAttribute を追加します。
```
[DatabaseSchemaProviderCompatibility(typeof(SqlDatabaseSchemaProvider))]
public class AddressGenerator : Generator
{
}
```
拡張機能の互換性属性の詳細については、「Visual Studio のデータベース機能の拡張」を参照してください。
[ファイル] メニューの [すべてを保存] をクリックします。

ジェネレーターへの出力プロパティの追加

前のセクションでは、Generator クラスを継承するクラスライブラリを作成しました。このセクションでは、クラスに出力プロパティを追加します。出力プロパティには、生成されたデータの値を指定します。出力プロパティは、このジェネレーターで生成できるデータの種類も指定します。

出力プロパティを追加するには

次の例に示すように、住所の生成に使用するメンバー変数を作成します。

_address 変数は、後の手順の出力プロパティで使用されます。

private Random _random;
private string _street;
private string _city;
private string _state;
private int _zipCode;
private string _address;

private static readonly List<String> _states =
            new List<string>() { "AK", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" };

次の例に示すように、_random メンバー変数のプライベートプロパティを作成します。

private Random Random
        {
            get
            {
                if (_random == null)
                    _random = new Random(base.Seed);

                return _random;
            }
        }

次の例に示すように、_address メンバー変数のパブリックプロパティを作成し、それに OutputAttribute を追加します。

[Output(Description = "Generates street and city values of \"2150 Newton Street, San Francisco\", with random state and zip code.", Name = "Address")]
        public string Address
        {
            get
            {
                return this._address;
            }
        }

[ファイル] メニューの [すべてを保存] をクリックします。

OnGenerateNextValues メソッドのオーバーライド

Visual Studio は、必要とする値のセットごとに各ジェネレーターの OnGenerateNextValues メソッドを呼び出します。データジェネレーターを作成する場合、このメソッドをオーバーライドして、出力プロパティのそれぞれに対して値を生成するロジックを指定する必要があります。

OnGenerateNextValues メソッドをオーバーライドするには

次の例に示すように、OnGenerateNextValues メソッドをオーバーライドします。

protected override void OnGenerateNextValues()
{
    this._street = "2150 Newton Street";
            this._city = "San Francisco";
            this._state = _states[Random.Next(0, _states.Count)];
            this._zipCode = Int32.Parse(String.Format("{0}{1}{2}{3}{4}", GetRandomDigit(1), GetRandomDigit(), GetRandomDigit(), GetRandomDigit(), GetRandomDigit()));
            this._address = String.Format("{0}, {1}, {2} {3}", _street, _city, _state, _zipCode);
}

_zipcode 変数の値の作成に使用する次のメソッドを追加します。

private int GetRandomDigit()
        {
            return GetRandomDigit(0);
        }

        private int GetRandomDigit(int lowNumber)
        {
            return Random.Next(lowNumber, 10);
        }

[ファイル] メニューの [すべてを保存] をクリックします。

ジェネレーターへの署名

次に、厳密な名前でカスタムデータジェネレーターに署名する必要があります。

ジェネレーターに厳密な名前で署名するには

[プロジェクト] メニューの [SampleGenerator のプロパティ] をクリックします。
[署名] タブの [アセンブリの署名] チェックボックスをオンにします。
[厳密な名前のキーファイルを選択してください] ボックスの一覧の [<新規作成...>] をクリックします。

[厳密な名前キーの作成] ダイアログボックスが表示されます。
[キーファイル] ボックスに「SampleGeneratorKey」と入力します。
パスワードとパスワードの確認を入力し、[OK] をクリックします。

ソリューションをビルドすると、このキーファイルを使ってアセンブリが署名されます。
[ファイル] メニューの [すべてを保存] をクリックします。
[ビルド] メニューの [ソリューションのビルド] をクリックします。

これで、カスタムデータジェネレーターが作成されました。

ジェネレーターアセンブリの登録

アセンブリが署名され、コンパイルされたら、ジェネレーターアセンブリの登録を効率化するために、プロジェクトで生成された、バージョン、カルチャ、PublicKeyToken などのアセンブリ情報を収集します。

アセンブリ情報を収集するには

[表示] メニューの [その他のウィンドウ] をポイントし、[コマンドウィンドウ] をクリックして、[コマンド] ウィンドウを開きます。
[コマンド] ウィンドウに、次のコードを入力します。 FilePath をコンパイル済みの .dll ファイルのパスとファイル名に置き換えます。パスとファイル名は引用符で囲みます。

注意

既定では、コンパイル済みの .dll ファイルのパスは SampleGenerator\bin\Debug です。
```
? System.Reflection.Assembly.LoadFrom(@"<FilePath>").FullName
```
Enter キーを押します。行は次のようになり、PublicKeyToken に固有の値が表示されます。
```
" SampleGenerator, Version=1.0.0.0, Culture=neutral, PublicKeyToken=nnnnnnnnnnnnnnnn"
```
このアセンブリ情報を記録またはコピーして、次の手順で使用します。

次に、前の手順で収集したアセンブリ情報を使用して XML ファイルを作成します。

XML ファイルを作成するには

ソリューションエクスプローラーで、SampleGenerator プロジェクトを選択します。
[プロジェクト] メニューの [新しい項目の追加] をクリックします。
[テンプレート] ペインで、[XML ファイル] という項目を見つけて選択します。
[名前] ボックスに「SampleGenerator.Extensions.xml」と入力し、[追加] をクリックします。

SampleGenerator.Extensions.xml ファイルがソリューションエクスプローラーのプロジェクトに追加されます。

注意

アセンブリを正しく登録するためには、dll の名前を使用する必要があります (この場合は、"SampleGenerator" の後に ".Extensions.xml" を付けます)。

SampleGenerator.Extensions.xml ファイルを開き、次の XML に一致するように更新します。前の手順で取得したアセンブリのバージョン、カルチャ、および PublicKeyToken を置換します。

注意

拡張機能の型には、クラスの完全修飾名を使用する必要があります。この例では、extension type="SampleGenerator.AddressGenerator" と指定します。

<?xml version="1.0" encoding="utf-8"?>
<extensions assembly="" version="1" xmlns="urn:Microsoft.Data.Schema.Extensions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:Microsoft.Data.Schema.Extensions Microsoft.Data.Schema.Extensions.xsd">
 
<extension type="SampleGenerator.AddressGenerator" assembly="SampleGenerator, Version=1.0.0.0, Culture=neutral, PublicKeyToken=nnnnnnnnnnnnnnnn" enabled="true"/>
 
</extensions>

[ファイル] メニューの [すべてを保存] をクリックします。

次に、アセンブリと XML ファイルを Extensions ディレクトリにコピーします。 Visual Studio Premium の起動時に、%Program Files%\Microsoft Visual Studio 10.0\VSTSDB\Extensions ディレクトリとそのサブディレクトリ内の拡張機能が識別され、セッションで使用できるように登録されます。

アセンブリと XML ファイルを Extensions ディレクトリにコピーして登録するには

%Program Files%\Microsoft Visual Studio 10.0\VSTSDB\Extensions\ ディレクトリに、CustomGenerators という名前のフォルダーを作成します。
作成した %Program Files%\Microsoft Visual Studio 10.0\VSTSDB\Extensions\ CustomGenerators フォルダーに、ProjectFolder\SampleGenerator\SampleGenerator\bin\Debug\ ディレクトリの SampleGenerator.dll アセンブリファイルをコピーします。
作成した %Program Files%\Microsoft Visual Studio 10.0\VSTSDB\Extensions\ CustomGenerators ディレクトリに、ProjectFolder\SampleGenerator\SampleGenerator\ ディレクトリの SampleGenerator.Extensions.xml ファイルをコピーします。

注意

拡張機能のアセンブリは、%Program Files%\Microsoft Visual Studio 10.0\VSTSDB\Extensions ディレクトリ内のフォルダーに配置することをお勧めします。これにより、製品に付属していた拡張機能と、カスタマイズして作成した拡張機能を区別しやすくなります。また、拡張機能をカテゴリごとに分類し、それぞれ別のフォルダーに保存することも検討してください。

住所ジェネレーターのテスト

住所データジェネレーターを作成したので、Visual Studio の新しいインスタンスを起動する必要があります。 Visual Studio が起動すると、%Program Files%\Microsoft Visual Studio 10.0\VSTSDB\Extensions\CustomGenerators ディレクトリに追加した SampleGenerator アセンブリが登録されます。次に、住所データジェネレーターが正しく動作することを確認できるデータベースプロジェクトを作成します。

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

Visual Studio の新しいインスタンスを起動します。このインスタンスが SampleGenerator.dll アセンブリを認識し、登録します。
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。

[新しいプロジェクト] ダイアログボックスが表示されます。
[インストールされたテンプレート] で、[データベース] ノードを展開し、[SQL Server] ノードをクリックします。
テンプレートの一覧の [SQL Server 2008 データベースプロジェクト] をクリックします。
[名前] ボックスに「SampleGeneratorDB」と入力します。

注意

「チュートリアル : CHECK 制約のカスタムデータジェネレーターの作成」の手順がすべて完了している場合は、SampleGeneratorDB プロジェクトが既に作成されているため、手順 9. に進むことができます。
[ソリューションのディレクトリを作成] チェックボックスをオンにします。
[場所] ボックス、[ソリューション名] ボックス、および [ソース管理に追加] ボックスの既定値をそのまま使用し、[OK] をクリックします。
[OK] をクリックします。

ソリューションエクスプローラーに、新しいデータベースプロジェクト SampleGeneratorDB が表示されます。
[表示] メニューの [データベーススキーマビュー] をクリックします。

スキーマビューがまだ表示されていない場合は、表示されます。

次に、列が 1 つだけの varchar SQL 型の単純なテーブルをプロジェクトに追加します。

データベースプロジェクトにテーブルを追加するには

スキーマビューで、[SampleGeneratorDB] ノード、[スキーマ] ノード、[dbo] ノードを順に展開し、[テーブル] ノードをクリックします。
[プロジェクト] メニューの [新しい項目の追加] をクリックします。

注意

スキーマビューで [SampleGeneratorDB] プロジェクトを右クリックし、[追加] をポイントして、[テーブル] をクリックするという方法もあります。
[テンプレート] の [テーブル] をクリックします。

注意

[カテゴリ] ボックスの一覧で、[テーブルとビュー] をクリックすると、テーブルのテンプレートをより簡単に検索できます。
[名前] ボックスに、新しいテーブルの名前として「Addresses」と入力します。
[追加] をクリックして、テーブルをデータベースプロジェクトに追加します。

ソリューションエクスプローラーに、データベースプロジェクトの新しいテーブルのファイルが表示されます。 スキーマビューに新しいテーブルオブジェクトが表示されます。 Transact-SQL エディターが表示され、新しいテーブルの定義が表示されます。
Transact-SQL エディターで、次の例に示すようにテーブルの定義を変更します。
```
CREATE TABLE [dbo].[Addresses]
(
address varchar(100)
)
```
[ファイル] メニューの [Addresses.table.sql の保存] をクリックします。

テーブルを追加したので、データベースを配置用に設定できます。

プロジェクト配置設定を構成するには

ソリューションエクスプローラーで、[SampleGeneratorDB] (ソリューションではなくプロジェクト) をクリックします。
[プロジェクト] メニューの [SampleGeneratorDB のプロパティ] をクリックします。

プロジェクトの [プロパティ] ウィンドウが表示されます。

注意

ソリューションエクスプローラーで [SampleGeneratorDB] を右クリックし、[プロパティ] をクリックするという方法もあります。
[配置] タブをクリックします。
[配置動作] ボックスの一覧の、[配置スクリプト (.sql) を作成してデータベースに配置します] をクリックします。
[編集] をクリックし、ターゲット接続を指定します。
SampleGeneratorDB データベースを配置するデータベースサーバーへの接続情報を指定します。
[データベースの選択または入力] に「SampleGeneratorDB」と入力します。
[OK] をクリックします。

[ターゲット接続] ボックスに接続文字列が入力されます。 [ターゲットデータベース名] は SampleGeneratorDB に設定されます。
その他のオプションについては既定値を使用します。
[ファイル] メニューの [選択されたファイルを上書き保存] をクリックします。

プロジェクトビルドの設定が保存されます。

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

データベースプロジェクトをビルドするには

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

データベースプロジェクトがビルドされます。成功した場合は、ステータスバーに "ビルド正常終了" というメッセージが表示され、出力ウィンドウにビルド結果が表示されます。

次に、データベースプロジェクトを配置します。

データベースプロジェクトをデータベースサーバーに配置するには

ソリューションエクスプローラーで、[SampleGeneratorDB] (ソリューションではなくプロジェクト) をクリックします。
[ビルド] メニューの [SampleGeneratorDB の配置] をクリックします。

ビルド構成に指定した接続を使用して、データベースプロジェクトが配置されます。 "配置に成功しました。" というメッセージがステータスバーと出力ウィンドウに表示されます。

データ生成計画の作成と設定

次に、データ生成計画を作成します。データ生成計画には、データ入力先のテーブルと列に関する情報が含まれています。詳細については、「方法：データ生成計画を作成する」を参照してください。

データ生成計画を作成および設定するには

ソリューションエクスプローラーで、[Data Generation Plans] ノードを選択します。
[プロジェクト] メニューの [新しい項目の追加] をクリックします。
カテゴリ ペインで、[データ生成計画] をクリックします。
テンプレート ペインで、[データ生成計画] をクリックします。
[プロジェクト名] ボックスに「SampleGenerator.dgen」と入力します。
[追加] をクリックします。

データ生成計画が作成されます。データ生成計画が表示されます。

データ生成計画ウィンドウは、上下 2 つのペインに分割されています。上のペインには、データベースプロジェクトスキーマ内に定義されているテーブル (ここでは dbo.Addresses テーブル) が一覧表示されます。下のペインには、上のペインで強調表示されているテーブルの列 (ここでは address 列) の詳細が表示されます。

注意

[データ生成プレビュー] ウィンドウが開いていない場合は、[データ] メニューの [データ生成] をポイントし、[データ生成のプレビュー] をクリックして開くことができます。既定では、[データ生成プレビュー] ウィンドウは、データ生成計画ウィンドウの下部にドッキングされ、タブが付けられています。ビューを展開するには、ウィンドウをクリックし、[ウィンドウ] メニューの [タブ付きドキュメント] をクリックします。タイトルバーを右クリックし、[タブ付きドキュメントとしてドッキング] をクリックするという方法もあります。
SampleGenerator.dgen デザイナーで、dbo.Addresses テーブルと address 列の両方のチェックボックスがオンになっていることを確認します。
SampleGenerator.dgen デザイナーで、address 列を選択し、[ジェネレーター] ボックスの一覧をクリックして [AddressGenerator] をクリックします。

これで、カスタム住所ジェネレーターが正しく設定されました。
[ファイル] メニューの [すべてを保存] をクリックします。

データ生成計画の実行による住所データの生成

最後に、データ生成計画を実行し、カスタム住所データジェネレーターの動作を確認します。

データ生成計画を実行するには

ソリューションエクスプローラーで、[SampleGenerator.dgen] をクリックします。

注意

また、データ生成計画も開いている必要があります。計画が開いていない場合は、最初に開いてください。
[データ] メニューの [データジェネレーター] をポイントし、[データの生成] をクリックします。

[データベースへの接続] ダイアログボックスが表示されます。
[データ生成接続情報] ボックスの一覧の [SampleGeneratorDB] データベースをクリックし、[OK] をクリックします。
新しい行を挿入する前にテーブルの内容を消去するかどうか確認するメッセージが表示された場合、[はい] をクリックします。

データが生成されます。 [母集団] ウィンドウで、状態列がデータ生成の状態に更新されます。ステータスバーには、全テーブルのデータ生成の概要が表示されます。
(省略可能) 別のツールを使用して、データベースにログオンします。この手順で、Visual Studio Premium に組み込まれた Transact-SQL エディターを使用できます。詳細については、Microsoft Web サイトの「データベーススクリプトと、Transact SQL エディターでのオブジェクトの編集」を参照してください。
次のクエリを実行して、新しいデータを表示します。
```
use SampleGeneratorDB

select * from dbo.Addresses
```
[結果] タブに、ランダムに生成された州と郵便番号で構成される住所が表示されます。

次の手順

Visual Studio Premium および Visual Studio Ultimate には DateTime ジェネレーターがあり、ジェネレーターの Min および Max プロパティを使用して日付が特定の範囲内にあることを要求する CHECK 制約が定義された列で使用できます。「チュートリアル : CHECK 制約のカスタムデータジェネレーターの作成」では、日付が 2 つの異なる範囲のいずれかに含まれていることを要求する CHECK 制約が定義された列に使用するカスタムデータジェネレーターを作成します。

参照

次の方法で共有

チュートリアル: カスタムデータジェネレーターの作成

必須コンポーネント

カスタムジェネレーターのクラスライブラリの作成

カスタムジェネレーターのクラスライブラリを作成するには

ジェネレーターへの出力プロパティの追加

出力プロパティを追加するには

OnGenerateNextValues メソッドのオーバーライド

OnGenerateNextValues メソッドをオーバーライドするには

ジェネレーターへの署名

ジェネレーターに厳密な名前で署名するには

ジェネレーターアセンブリの登録

アセンブリ情報を収集するには

XML ファイルを作成するには

アセンブリと XML ファイルを Extensions ディレクトリにコピーして登録するには

住所ジェネレーターのテスト

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

データベースプロジェクトにテーブルを追加するには

プロジェクト配置設定を構成するには

データベースプロジェクトをビルドするには

データベースプロジェクトをデータベースサーバーに配置するには

データ生成計画の作成と設定

データ生成計画を作成および設定するには

データ生成計画の実行による住所データの生成

データ生成計画を実行するには

次の手順

参照

処理手順

参照

概念

その他の技術情報

その他のリソース

次の方法で共有

チュートリアル: カスタム データ ジェネレーターの作成

必須コンポーネント

カスタム ジェネレーターのクラス ライブラリの作成

カスタム ジェネレーターのクラス ライブラリを作成するには

ジェネレーターへの出力プロパティの追加

出力プロパティを追加するには

OnGenerateNextValues メソッドのオーバーライド

OnGenerateNextValues メソッドをオーバーライドするには

ジェネレーターへの署名

ジェネレーターに厳密な名前で署名するには

ジェネレーター アセンブリの登録

アセンブリ情報を収集するには

XML ファイルを作成するには

アセンブリと XML ファイルを Extensions ディレクトリにコピーして登録するには

住所ジェネレーターのテスト

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

データベース プロジェクトにテーブルを追加するには

プロジェクト配置設定を構成するには

データベース プロジェクトをビルドするには

データベース プロジェクトをデータベース サーバーに配置するには

データ生成計画の作成と設定

データ生成計画を作成および設定するには

データ生成計画の実行による住所データの生成

データ生成計画を実行するには

次の手順

参照

処理手順

参照

概念

その他の技術情報

その他のリソース

チュートリアル: カスタムデータジェネレーターの作成

カスタムジェネレーターのクラスライブラリの作成

カスタムジェネレーターのクラスライブラリを作成するには

ジェネレーターアセンブリの登録

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

データベースプロジェクトにテーブルを追加するには

データベースプロジェクトをビルドするには

データベースプロジェクトをデータベースサーバーに配置するには