SQL Database プロジェクトを使用する

  • 7 分

SQL Database Projects 拡張機能は、Visual Studio Code にインストールできる開発者ツールです。 この拡張機能は、プロジェクト ベースの環境での SQL データベースの開発と管理を容易にするように設計されています。 SQL Server、Azure SQL Database、Azure SQL Managed Instance、Azure Synapse SQL など、いくつかの SQL プラットフォームと互換性があります。

データベース スキーマを作成または変更でき、変更は .dacpac ファイル形式で保存されます。 SQL データベース プロジェクトは、SQL Database Projects 拡張機能を使用するか、コマンド ライン インターフェイス SqlPackage を使用して .dacpac を発行することで公開できます。

SQL Database Projects 拡張機能を使用すると、新しい空のプロジェクトを作成するか、接続されたデータベースから新しいプロジェクトを作成できます。 その後、テーブル、ビュー、ストアド プロシージャ、関数、カスタム スクリプトなどのオブジェクトを追加、変更、または削除できます。

Database Projects 拡張情報をインストールする

SQL Database Projects 拡張機能は、mssql 拡張機能の一部としてインストールされます。 Visual Studio Code の mssql 拡張機能を使用すると、SQL Server に接続し、T-SQL を使用してクエリを実行し、その結果を表示できます。

SQL Database Projects 拡張機能がインストールされていることを示すスクリーンショット。

最新の .NET SDK がインストールされていることが前提条件です。 インストールされていない場合は、インストールするように求められます。

スキーマをインポートして変更する

SQL Database Projects 拡張機能をインストールし、データベース プロジェクトを作成する準備ができました。 この例では、既存の Azure SQL Database に接続します。

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

データベース プロジェクトは、データベース スキーマの設計、開発、管理の開始点です。 それによって、テーブル、ビュー、ストアド プロシージャ、その他のデータベース オブジェクトを定義できる構造化された環境が提供されます。

  1. Visual Studio Code の左側のメニューで、[データベース プロジェクト] を選択し、[新規作成] を選択します。
  2. [データベース プロジェクトの種類の選択] で [空のプロジェクトからの Azure SQL Database] を選択します。
  3. [プロジェクト名] でプロジェクトの名前を選択するか、入力します。
  4. [場所] で、プロジェクトが保存されるローカル コンピューター上のフォルダーを選択または参照します。
  5. メッセージが表示されたら、SDK スタイルのプロジェクトに対して [はい] を選択します。 データ プロジェクトが作成されます。

接続を追加する

Visual Studio Code でデータベースの操作を開始する前に、Azure SQL データベースへの接続を確立する必要があります。 この接続によって IDE からデータベースを直接操作できるようになり、クエリの実行、データベース オブジェクトの管理、その他のデータベース関連タスクの実行が可能になります。 手順に従って、Azure SQL Database への接続を追加します。

  1. 左側のメニューから、[SQL Server] を選びます。
  2. [接続の追加] を選択します。
  3. [サーバー名] に SQL Server の名前を入力します。 サーバーの名前は、Azure portal からコピー/ペーストできます。
  4. データベース名 を入力します。
  5. 認証の種類、ユーザー名、パスワードを選択します。
  6. [プロファイル名] に接続プロファイルの名前を入力します。 この手順は省略可能です。
  7. データベース接続が [接続] ノードの下に表示されます。

既存のデータベースから新しい SQL データベース プロジェクトを作成する

既存のデータベースから新しい SQL Database プロジェクトを作成すると、現在のデータベース スキーマを構造化されたプロジェクト形式にインポートできます。 既存のデータベースから新しい SQL Database プロジェクトを作成するには、次の手順に従います。

  1. データベースを右クリックして、[データベースからプロジェクトを作成] を選びます。
  2. [データベースの選択] で、データベースを選択します。
  3. [プロジェクト名を入力] でプロジェクトを選択します。
  4. [場所の選択またはプロジェクトの作成] で、フォルダーを参照します。
  5. [フォルダー構造の選択] で [スキーマ/オブジェクト型] を選択します。
  6. [プロジェクトにアクセス許可を含める] で [いいえ (既定値)] を選択します。
  7. [SDK スタイルのプロジェクト (プレビュー)] で [はい (推奨)] を選択します。
  8. メッセージが表示されたら、[はい] を選択してファイルの作成者を信頼します。
  9. データベース オブジェクト ツリーを展開して、テーブルとその他のオブジェクトを表示します。
  10. スキーマを変更するには、オブジェクトを選択します。
  11. [ファイル]> [保存] を選択してから、タブを閉じます。

スキーマの変更をデプロイする

データベース スキーマを変更 (新しいテーブルの追加、既存の列の更新、新しいストアド プロシージャの作成など) した後に Azure SQL データベースに変更をデプロイするには、次の手順を実行します。

  1. アクティビティ バーにある [データベース プロジェクト] を選択します。
  2. プロジェクトを右クリックして [ビルド] を選択します。
  3. 次に、プロジェクトを右クリックして [公開] を選択します。
  4. [プロジェクトの公開先を選択します] で [既存の Azure SQL 論理サーバーに発行します] を選択します。
  5. [読み込む発行プロファイルを選択してください] で、[プロファイルを使用しません] を選択します。
  6. [下の一覧から、接続プロファイルを選択します] で、データベースを選択します。
  7. [アクションの選択] で、[公開] を選択します。
  8. データベース ビューを更新して、スキーマの変更が行われていることを確認します。

既存の Azure SQL 論理サーバーに発行する方法を示すスクリーンショット。