ビルド コントリビューターおよび配置コントリビューターを利用してデータベースのビルドおよび配置をカスタマイズする

Visual Studio には、データベース プロジェクトにおいてビルドおよび配置アクションの動作を変更するために使用できる拡張ポイントが用意されています。 それらの拡張ポイントは、どのようなデータベース スキーマ プロバイダー (DSP) の実装にも適用できるように定義されています。

使用可能な拡張ポイント

次の表に示す拡張ポイントについて、拡張機能を作成できます。

サポートされる機能拡張シナリオ

ビルド コントリビューターまたは配置コントリビューターを実装することにより、次のサンプル シナリオを実現できます。

• プロジェクトのビルド中にスキーマ ドキュメントを生成する
  このシナリオをサポートするには、BuildContributor を実装し、OnExecute メソッドをオーバーライドして、スキーマ ドキュメントを生成します。 OnPopulateArguments メソッドをオーバーライドすることにより、拡張機能を実行するかどうかを制御する既定の引数を公開し、出力ファイルの名前を指定できます。

• データベース プロジェクトを配置するときに差分レポートを生成する
  このシナリオをサポートするには、データベース プロジェクトを配置するときに XML ファイルを生成する DeploymentPlanExecutor を実装します。

• 配置計画においてデータの移動が発生する時点を変更する
  このシナリオをサポートするには、DeploymentPlanModifier を実装し、配置の再生を繰り返します。 計画の SqlTableMigrationStep ごとに比較結果を調べ、そのステップを実行するかスキップするかを決定します。

• データベース プロジェクトを配置するときにファイルをビルド出力フォルダーにコピーする
  このシナリオをサポートするには、配置コントリビューターを実装し、OnEstablishDeploymentConfiguration メソッドをオーバーライドして、(プロジェクト システムによって) DeploymentConfigurationExtension とマークされたファイルのうちどれを出力フォルダーにコピーするかを指定します。 複数のファイルを 1 つの新しいファイルに結合し、それを出力フォルダーにコピーして配置マニフェストに追加するように、コントリビューターを変更することもできます。

さらに、コントリビューターからカスタマイズされた名前/値引数のペアを公開し、データベース プロジェクト ファイルに書き込むこともできます。 これらの引数を使用すると、コントリビューターが MSBuild から情報を抽出でき、またコントリビューターのエンド ユーザーは動作をカスタマイズできます。 たとえば、ユーザーが入力ファイルや出力ファイルの名前を指定できるようにすることも可能です。

一般的なタスク

関連するシナリオ

カスタムのデータベース リファクタリングの種類またはターゲットの作成

データベース コード分析用の追加規則の作成と登録

カスタム データ ジェネレーターを使用した特殊なテスト データの生成

データベース単体テストのカスタム条件の定義

参照

概念

Visual Studio のデータベース機能の拡張

データベースのビルドおよび分離開発環境への配置

データベースのビルドとステージング環境または稼動環境への配置