Visual Studio Code の mssql 拡張機能

  • [アーティクル]

この記事では、Visual Studio Code (VS Code) の mssql 拡張機能を使用して、Windows、macOS、Linux 上の SQL Server、および Azure SQL Database と Azure SQL Managed Instance のデータベースを操作する方法について説明します。 Visual Studio Code の mssql 拡張機能は、Azure SQL と SQL Server のクエリ機能に加え、Azure Functions で SQL プロジェクトと SQL バインドを使用する開発者向けの追加機能を提供します。 VS Code の mssql 拡張機能には、SQL Database プロジェクト拡張機能が含まれます。

機能の概要

VS Code の mssql 拡張機能では、次の機能を使用できます。

  • Microsoft SQL Server、Azure SQL Database、Azure SQL Managed Instance、Azure Synapse Analytics 専用 SQL プールに接続する。
  • 接続プロファイルと最近使用した接続を作成および管理する。
  • IntelliSense、定義へ移動、T-SQL スニペット、構文の色付け、T-SQL エラー検証、GO バッチ区切り記号を使用して T-SQL スクリプトを記述する。
  • スクリプトを実行し、簡単に使用できるグリッドで結果を表示する。
  • 実行されたクエリ履歴にアクセスする。
  • 結果を json または csv ファイル形式で保存し、エディターで表示する。
  • コマンド ショートカットなどのカスタマイズ可能な拡張機能オプション。
  • SQL バインドを使用して Azure 関数を作成する。

Azure Data Studio と mssql 拡張機能を比較する

Windows、macOS、Linux では、Azure Data Studio と VS Code の mssql 拡張機能の両方を使用できます。

VS Code で Azure SQL と SQL Server を使用すると、次のようなベネフィットがあります。

  • SQL とそれ以外のコード (C#、Python、JavaScript、Java、PHP、Go など) で 1 つのコード エディター。
  • リモート開発やコンテナーなどのための拡張機能を備えた広範な拡張機能マーケットプレース。
  • GitHub Codespaces で使用できる。

次の機能を利用するには、VS Code の mssql 拡張機能に加えて Azure Data Studio を使用することを検討してください。

  • グラフをすばやく作成し、結果セットを視覚化する
  • グラフィカル テーブル デザイナーとクエリ プラン。
  • データベース、SQL プロジェクト、dacpac のスキーマ比較。
  • SQL Agent、SQL Profiler、フラット ファイルのインポートの拡張機能。
  • SQL と .NET の対話型ノートブック。

VS Code の mssql 拡張機能の概要

mssql 拡張機能をインストールする

VS Code に mssql 拡張機能をインストールするには、次のステップに従います。

  1. お使いのコンピューターに Visual Studio Code をダウンロードしてインストールします。

  2. Visual Studio Code で、 [表示]>[コマンド パレット] を選択する、Ctrl+Shift+P を押す、または F1 を押して [コマンド パレット] を開きます。

  3. コマンド パレットで、ドロップダウンから [拡張機能: 拡張機能のインストール] を選択します。

  4. [拡張機能] ウィンドウで、「mssql」と入力します。

  5. [SQL Server (mssql)] 拡張機能を選択し、[インストール] を選択します。

    Visual Studio Code、mssql 拡張機能のインストールのスクリーンショット。

  6. インストールが完了したら、[再読み込み] を選択して拡張機能を有効にします。

接続とクエリ

SQL インスタンスに接続し、データベースに対してクエリを実行するには、次の手順に従います。

  1. [SQL Server] ペインで、[接続] ビューレットから [接続の追加] 接続アイコン (プラス記号) を選択します。

  2. 指示に従って、新しい接続プロファイルの接続プロパティを指定します。 それぞれの値を指定した後、Enter キーを押して続行します。

    Connection プロパティ 説明
    サーバー名または ADO 接続文字列 SQL Server インスタンス名を指定します。 ローカル コンピューター上の SQL Server インスタンスに接続するには、localhost を使用します。 リモート SQL Server に接続するには、ターゲットの SQL Server の名前か、その IP アドレスを入力します。 SQL Server コンテナーに接続するには、コンテナーのホスト コンピューターの IP アドレスを指定します。 ポートを指定する必要がある場合は、コンマを使用して名前と区別します。 たとえば、ポート 1401 でリッスンしているサーバーの場合は、「<servername or IP>,1401」と入力します。

    既定では、接続文字列ではポート 1433 が使用されます。 SQL Server の既定インスタンスでは、変更されていない限り 1433 が使用されます。 インスタンスが 1433 でリッスンしている場合、ポートを指定する必要はありません。

    別の方法として、お使いのデータベースの ADO 接続文字列をここに入力できます。
    データベース名 (省略可能) 使用するデータベース。 既定のデータベースに接続するには、ここにデータベース名を指定しないでください。
    認証の種類 [統合] または [SQL ログイン] を選択します。
    ユーザー名 [SQL ログイン] を選択した場合は、サーバー上のデータベースにアクセスできるユーザーの名前を入力します。
    パスワード 指定したユーザーのパスワードを入力します。
    パスワードを保存する Enter キーを押すことで [はい] を選択して、パスワードを保存します。 [いいえ] を選択すると、接続プロファイルを使用するたびにパスワードの入力を求められます。
    プロファイル名 (省略可能) 接続プロファイルの名前を入力します (localhost プロファイル など)。

    すべての値を入力して Enter キーを押すと、Visual Studio Code によって接続プロファイルが作成され、SQL Server に接続します。

    暗号化を有効にして (既定値) 最初の接続試行に失敗した場合、mssql 拡張機能によって通知プロンプトが表示され、[サーバー証明書を信頼する] を有効にして接続を試行するオプションが表示されます。 このオプションの詳細については、接続に関するチュートリアルを参照してください。

サポートされるオペレーティング システム

VS Code の mssql 拡張機能は、Windows、macOS、および Linux でサポートされています。 次のバージョンがサポートされています。

  • Windows: 7 (SP1)、8、8.1、10、11
  • Windows Server: 2016、2019、2022
  • macOS: 10.12 以降、11、12
  • Linux: Debian 9 以降、RHEL 7 以降、Ubuntu 18.04 以降

SQL ツール サービス

mssql 拡張機能により、SQL ツール サービスが自動的にインストールされます。これは、Azure Data Studio や VS Code の mssql 拡張機能を含むサービスをいくつかの SQL ツールに提供する、オープン ソースの NET ベースの API です。 SQL ツール サービスには、一般的な言語サービス操作 (IntelliSense オートコンプリート候補、ピーク定義、SQL エラー診断、QuickInfo ホバー)、接続管理、クエリ実行などの機能が用意されています。 SQL ツール サービスのソース コードは、GitHub で入手できます。

次のステップ