この記事について

この記事では、Visual Studio Code 上で、以下のデータベースに接続して値を確認する方法について解説します。

Azure SQL Database
SQL Server

従来の開発では、SQL Server Management StudioやAzure Data Studio、Azure ポータルの画面など、コーディングを行う場所とは異なるアプリケーションを並行で起動する事例も多かったと思います。
コーディング中にデータベースにアクセスしたくなり別のアプリを起動・切り替えというようなことは正直面倒で無駄の時間につながります。
Visual Studio Code のみで、コーディングだけでなく、データベースの値も確認できることは、開発中に複数のアプリケーションを起動・行き来しなければならないというような、ちょっとした面倒を軽減させることが可能です。

Visual Studio Code 拡張機能

今回利用する拡張機能は、こちらです。

SQL Server (mssql)
- https://github.com/Microsoft/vscode-mssql

SQL Database に接続

SQL Server または SQL Database に接続する場合は、SQL Server (mssql) 拡張機能を使用します。
拡張機能をインストールすると、SQL Serverタブが表示されるようになります。

サーバーファイアウォールの設定

SQL Database にはサーバーファイアウォールの設定があります。
ここで、自身の端末のクライアント IPからの接続を許可しておく必要があります。
設定していない場合は、事前に設定しておきます。

接続プロファイルの作成

Add Connectionを選択して、接続情報を作成します。今回は、SQL Database に接続します。

もし、以下のような表示が行われた場合は、現在開いているファイルの言語モードを SQL にする必要があるかどうかについて聞かれているので、Yes または No を選択してください。

サーバー名または、ADO.NETの接続文字列を入力します。

SQL Database の場合、ADO.NET 接続文字列は Azure ポータルから簡単に取得できます。
ただし、Password={your_password}; の部分は変更する必要があるため、設定したパスワードに書き換えてください。

入力したら、Enter キーを押します。

プロファイルとして保存する際の名前の入力を求められます。任意の名前を設定してください。
入力したら、Enter キーを押します。

登録が正常に完了した場合、以下のように SQL Database に接続できるようになります。

クエリ実行

接続情報の部分を右クリックします。
New Queryを選択します。

言語モードが SQL に設定されたタブが表示されます。
画面右下の部分に、SQL Database に接続できているかどうか表示されるため、確認しておきましょう。

開いたタブの画面にて、クエリを作成します。
※画面は、CREATE TABLE 文の例です

クエリを作成したら、画面を右クリックまたは[Ctrl] + [Shift] + [E] (macOS の場合は、[Command] + [Shift] + [E])でクエリを実行します。

クエリの実行結果は、別タブで表示されるようになります。

SELECT や UPDATE などのクエリを実行できるため、プログラム側で実行するクエリの実行結果を、こちらの画面で簡単に確認できます。

その他、便利機能

この拡張機能には、スペニットなど、便利なコマンドも用意されています。
詳細は、以下の記事を参照してください。

VSCodeでのSQL Server(MSSQL)の開発

データベースに接続できなくなった時の対処

接続中のはずなのに接続エラーになる場合

いったん、サーバーとの接続を切断し、再接続することをお勧めします。
サーバーを右クリックし、Disconnectを選択して接続を切断します。

切断後、Connectを選択して、再度データベースに接続してみてください。

接続プロファイルの情報が変更になった場合

SQL Server (mssql) 拡張機能で作成したプロファイル情報は、Visual Studio Code のユーザー設定情報(settings.json)の中に保存されています。
※settings.json の場所がわかっている方は、そのまま直接開いて編集を行ってください

[Ctrl] + [,] (macOS の場合は、[Command] + [,])で、ユーザー設定画面を開きます。

※Windows の場合は、メニューの [ファイル] -> [ユーザー設定] -> [設定] からでも遷移できます。
※macOS の場合は、メニューの [Code] -> [基本設定] -> [設定] からでも遷移できます。

[ユーザー] タブにて、Mssql: Connectionを入力します。
該当するものが表示されるので、setting.json で編集 リンクを選択します。

mssql.connections 内にて、定義済みの接続プロファイル情報が表示されます。
必要に応じて書き換え・削除し、保存を行ってください。

参考情報

VSCodeでのSQL Server(MSSQL)の開発