SQL プロジェクトのツールは、いくつかの開発環境とコマンド ライン インターフェイスで使用できます。 SQL プロジェクトの主なツールは、SqlPackage コマンド ライン ユーティリティ、Visual Studio の SQL Server Data Tools (SSDT)、Azure Data Studio と Visual Studio Code 用の SQL Database プロジェクトの拡張機能です。
この記事に含まれるツール:
グラフィカル ツール
これらのツールは、SQL プロジェクト、T-SQL エディター、ビルドおよび発行プロセスのグラフィカル インターフェイスを提供します。
SQL Server Data Tools (SSDT) は、SQL プロジェクトのグラフィカル インターフェイスを提供する Visual Studio コンポーネントです。 SSDT には、テーブル用のビジュアル デザイナー、T-SQL エディター、ビルドおよび発行プロセスが用意されています。
SQL Database プロジェクトの拡張機能は、Azure Data Studio (ADS) と VS Code 用の拡張機能です。 この拡張機能は、SQL プロジェクト、T-SQL エディター、ビルドおよび発行プロセスのグラフィカル インターフェイスを提供します。
機能セットの比較
| 機能 | SDK スタイルの SSDT | SSDT | ADS | VS Code |
|---|---|---|---|---|
| 新しい空のプロジェクトを作成する | X | X | X | X |
| 既存のデータベースから新しいプロジェクトを作成する | X | X | X | |
| 既存の Microsoft.Build.Sql プロジェクトを開く | X | X | X | |
| ソリューションの管理と操作 | X | X | ||
| プロジェクトの実行ビルド | X | X | X | X |
| プロジェクトを既存のサーバーに発行する | X | X | X | X |
| プロジェクトをローカル開発インスタンスに発行する | X1 | X1 | X2 | X2 |
| 発行オプション/プロパティ | X | X | X | |
| ターゲット プラットフォームを更新できる | X | X | X | X |
| SQLCMD 変数 | X | X | X | X |
| プロジェクト参照 | X | X | ||
| Dacpac 参照 | X | X | X | |
| パッケージ参照 | X | |||
| 発行プロファイル作成 | X | X | X | |
| SQL ファイルはプロジェクト フォルダーに配置すると追加できる | X | X | X | |
| SQL ファイルをビルドから除外できる | X | X | ||
| 配置前/配置後スクリプト | X | X | X | X |
| 新しいオブジェクト テンプレート | X3 | X | X3 | X3 |
| プロジェクト ファイルをフォルダーに整理できる | X | X | X | X |
| スキーマ比較プロジェクトからデータベースへ | X | X | ||
| スキーマ比較データベースからプロジェクトへ | X | X | ||
| グラフィカル テーブル デザイナー | X | X | ||
| コード分析 - ルールの有効化/無効化 | X | |||
| プロジェクト プロパティ - ビルド出力の設定 | X | X | ||
| プロジェクト プロパティ - 既定のスキーマ | X | |||
| プロジェクト プロパティ - データベースの設定 | X | |||
| プロジェクトのコード分析をスタンドアロンで実行 | X | |||
| オブジェクトの名前変更とリファクタリング | X | |||
| プロジェクトモデルからのデータベースファイルに Intellisense が提供されます | X | |||
| SQL Server オブジェクト エクスプローラーの接続とオブジェクトの表示 | X | X | X | X |
| SQL Server オブジェクト エクスプローラーのコンテキスト メニュー項目 | X | X | X | |
| SQL Server クエリ エディターの接続 | X | X | X |
- ローカル開発インスタンスは、SQL Server LocalDB インスタンスです。
- ローカル開発インスタンスは SQL Server コンテナーです。
- 使用できるテンプレートのサブセットは限定されています
コマンド ライン ツール
SqlPackage は DacFx ライブラリの主要なコマンド ライン ユーティリティであり、.dacpac をデータベースにデプロイしたり、データベースのオブジェクトを SQL プロジェクトや .dacpac に抽出したりするなどのデータべース開発タスクの自動化を可能にします。
DacFx .NET ライブラリを使用してカスタム コンソール アプリケーションを構築し、データベース開発タスクを自動化できます。 Microsoft.SqlServer.Dac 名前空間には、データベース オブジェクトを作成、デプロイ、および抽出するためのクラスが含まれており、DacFx ライブラリの残りの部分の基礎となります。
CI/CD パイプラインは、コマンド ラインの実行、または .dacpac および SQL プロジェクトのデプロイに固有のタスクを使用して構築できます。 タスクの例としては GitHub sql-action や Azure DevOps の SqlAzureDacpacDeployment が挙げられますが、これらのタスクでは管理レイヤーの下にある SqlPackage が使用されるため、データベースの変更のデプロイが容易になります。
変換ツール
既存の SQL プロジェクトを SDK スタイルのプロジェクトに変換するプロセスは、新しい SDK スタイルのプロジェクト形式を含むように.sqlproj ファイルを手動で編集することによって行われます。 プロセスを開始する前に、プロジェクト ファイルをバックアップし、プロジェクトの .dacpac をアーカイブすることをお勧めします。 プロジェクトからビルドされた "before" と "after" .dacpac を比較することで、変換プロセスが正しく完了していることを確認できます。
プロジェクト/ソリューション管理
複数の SQL プロジェクト (およびその他のプロジェクト) をソリューション ファイルに論理的にグループ化できます。 ソリューション ファイルは 1 つ以上のプロジェクトのコンテナーであり、ビルド アクションを含むグループとしてプロジェクトを管理するために使用されます。 大規模なソリューションを小さなソリューションに分割してパフォーマンスと管理性を向上させたり、手元の適切なタスクに合わせて動的に生成したりできます。 slngen ソリューション ファイル ジェネレーターは Microsoft.Build.Sql プロジェクトで使用でき、プログラムとオンデマンドで一連のプロジェクトのソリューション ファイルを作成するために使用できます。
サードパーティ製のツール
SQL プロジェクトとデータベースのデプロイに関連する機能を提供するサード パーティ製のツールを使用できます。 dbatools など、一部のツールはオープンソースです。
開発者は、SQL プロジェクトに関する拡張ポイントを活用して、コード分析や展開プランのカスタマイズなど、さまざまなプロジェクトを共有しています。 これらのプロジェクトの一部を次に示します。
- https://github.com/tcartwright/SqlServer.Rules
- https://github.com/davebally/TSQL-Smells
- https://github.com/ErikEJ/SqlServer.Rules
- https://github.com/GoEddie/DeploymentContributorFilterer