Visual Studio Code のための MSSQL 拡張機能

Visual Studio Code 用の MSSQL 拡張機能は、Azure SQL(Azure SQL Database、Azure SQL Managed Instance、Azure Virtual Machines 上の SQL Server を含む)、Microsoft Fabric の SQL データベース、および SQL Server を使用するアプリケーションを開発する開発者をサポートします。 データベースへの接続、スキーマの管理と設計、データベース オブジェクトの探索、Transact-SQL (T-SQL) クエリの実行、Visual Studio Code 内でのクエリ実行プランの表示を行うツールが用意されています。

この拡張機能には、IntelliSense、T-SQL スクリプトの実行、ローカルデータベースとクラウドベースデータベースのカスタマイズ可能なオプションが含まれます。

Visual Studio Code用のMSSQL拡張機能をインストールしてください

Visual Studio Code で SQL 開発を開始するには、 MSSQL 拡張機能をインストールします。

  1. Visual Studio Code を開きます。
  2. アクティビティ バー (macOS の場合は Cmd++、Windows および Linux では Ctrl++) の拡張機能アイコンを選択します。
  3. 検索バーに「mssql」と入力します。
  4. 結果で SQL Server (mssql) を見つけて選択します。
  5. [インストール] ボタンを選択します。

Visual Studio Code 用 MSSQL 拡張機能のスクリーンショット。

ヒント

アクティビティ バーに MSSQL アイコンが表示され、[ 接続 ] ビューが使用可能になると、拡張機能が正しくインストールされていることがわかります。

特徴

Visual Studio Code 用の MSSQL 拡張機能は、Fabric の SQL Server、Azure SQL、および SQL データベースをサポートしています。

次の表は、MSSQL 拡張機能で使用できる機能の概要、リリースの状態、および詳細なドキュメントへのリンクを示しています。

特徴 地位 説明
接続ダイアログ GA パラメーター、接続文字列、または Azure を閲覧して接続する
オブジェクト エクスプローラー GA 型に対応した検索を使用してデータベース オブジェクトを参照およびフィルター処理する
クエリ結果ペイン GA クエリ結果の表示、並べ替え、コピー、エクスポート
クエリプランの可視化ツール GA 対話型ノード ナビゲーションを使用して実行プランを分析する
テーブルデザイナー GA ビジュアル インターフェイスを使用してテーブルを作成および管理する
スキーマデザイナー GA ドラッグ アンド ドロップと自動レイアウトを使用したビジュアル スキーマ モデリング
スキーマ比較 GA データベースまたは DACPAC 間でスキーマを比較および同期する
GitHub Copilot 連携 GA 自然言語チャットとエージェント モードを使用した AI 支援 SQL 開発
ローカル SQL Server コンテナ GA SQL Server コンテナーをローカルで作成および管理する
データの表示と編集 GA DML を記述せずにテーブル データをインラインで参照および変更する
データ層アプリケーション(DACPAC および BACPAC) GA DACPAC ファイルと BACPAC ファイルの展開、抽出、インポート、エクスポート
Fabric 統合 GA Fabric ワークスペースを参照し、SQL データベースをプロビジョニングする
データベース管理 GA オブジェクト エクスプローラーからデータベースを作成、名前変更、および削除する
バックアップとリストア GA データベースをディスクまたは URL にバックアップし、バックアップから復元する
データベースオブジェクト検索 GA 型に対応した検索を使用してテーブル、ビュー、関数、ストアド プロシージャを検索する
フラット ファイルをインポート GA .csvファイルと.txt ファイルを新しい SQL Server テーブルにインポートする
クエリプロファイラ GA 拡張イベントを使用したリアルタイムのデータベース アクティビティ監視
クエリパフォーマンスダッシュボード パブリック プレビュー クエリ ストア データを分析し、クエリパフォーマンスを比較し、実行履歴、待機時間、計画を確認する
GitHub Copilot 搭載のスキーマ デザイナー GA ビジュアル変更追跡と ORM スクリプト生成を使用した自然言語スキーマの設計
データ API ビルダー GA SQL データベースの REST、GraphQL、および MCP エンドポイントを作成する
SQLノートブック GA 豊富な結果とマルチカーネルサポートを備えた Jupyter ベースの SQL ノートブック
SQL Formatter GA T-SQLをオンデマンドまたはセーブ時にフォーマットし、設定可能なフォーマットオプションで対応できます
Azure 連携 GA free レベルから始めて、Visual Studio Codeから直接Azure SQLデータベースをプロビジョニングする
ローカルからクラウドへの展開ウィザード パブリック プレビュー 互換性チェックを行いながら、ローカル データベース スキーマ、またはスキーマとデータを無料利用枠の Azure SQL Database に展開する
ショートカットの設定 GA 頻繁に使われるクエリやその他のエディタコマンドのキーボードショートカットを管理します

接続ダイアログ

[接続] ダイアログには、Azure SQL でホストされているデータベース (Azure SQL Database、Azure SQL Managed Instance、Azure VM 上の SQL Server など)、Fabric の SQL データベース、または SQL Server に接続するための直感的なインターフェイスが用意されています。 さまざまなシナリオに対応するための複数の入力オプションが用意されています。

  • パラメータ: サーバー名、データベース名、ユーザー名、パスワードなどの個別接続情報を入力します。

  • Connection String:より高度な構成のために、完全な 接続文字列 を直接入力できます。

  • Azure を参照:Azure アカウント内で利用可能なデータベースインスタンスとデータベースを閲覧し、サブスクリプション、リソースグループ、場所別に絞り込むオプションがあります。

  • 接続グループ:接続をフォルダにグループ化し、色を割り当てて環境を整理し、素早く視覚的に識別できます。 接続を作成または編集するときに、グループを簡単に割り当てたり変更したりできます。

[接続] ダイアログには、[ 保存された接続] パネルと [最近使用した 接続 ] パネルが表示され、以前に使用したサーバーへの再接続が簡単になります。 このレイアウトでは、接続の詳細の編集と保存がサポートされ、サーバーまたはデータベースを簡単に切り替えることができます。

接続ダイアログ機能のスクリーンショット。

データベース操作

MSSQL 拡張機能には、次のような一般的な データベース操作用の組み込みツールが用意されています。

  • データベース管理:オブジェクト エクスプローラー からデータベースを作成、名前変更、削除できます。
  • データベース オブジェクト検索: オブジェクトの種類を認識する検索とコンテキストに応じた操作で、テーブル、ビュー、関数、ストアド プロシージャを見つけます。
  • バックアップと復元: データベースをディスクまたは Azure Blob Storage にバックアップし、既存のバックアップ、バックアップ ファイル、または Azure Blob Storage から復元します。
  • フラットファイルをインポート:ガイドウィザードを使って.csvおよび.txtファイルを新しいSQL Serverテーブルにインポートします。

オブジェクト エクスプローラー (フィルター処理)

オブジェクト エクスプローラーを使用すると、データベース、テーブル、ビュー、プログラミング項目などのデータベース オブジェクトを探索できます。 フィルター処理は、大規模なデータベース階層内の特定のオブジェクトを見つけるのに役立ちます。

  • フィルターを適用:データベースオブジェクトを名前、所有者、作成日などのプロパティでフィルターします。 データベース、テーブル、ビュー、プログラミングなど、複数のレベルでフィルターを適用できます。

  • フィルターの編集: 既存のフィルターを調整または更新し、オブジェクトリストをさらに絞り込むことができます。

  • フィルターをクリア:適用されているフィルターを解除して、階層内のすべてのオブジェクトを表示します。

Object Explorer のフィルター機能のスクリーンショット。

テーブル デザイナー

この機能を使うには、オブジェクト エクスプローラーでテーブルを右クリックし、「Modify Table Structure」を選択します。

テーブル デザイナーには、テーブルを作成および管理するためのビジュアル インターフェイスが用意されています。

  • 列: 新規の列の追加、データ型の設定、NULL を許可するかどうかの定義、デフォルト値の指定。 また、インターフェイス内で、列を主キーすなわち ID 列として直接指定することもできます。

  • プライマリキー:テーブルのプライマリキーとして1つ以上の列を定義し、各行が一意に識別できるようにしてください。

  • インデックス:追加のカラムをインデックスとして追加し、より高速なデータ検索のためにクエリ性能を向上させるインデックスを作成・管理します。

  • 外部キー:他のテーブルの主キーを参照する外部キーを追加することで、テーブル間の関係を定義し、テーブル間のデータの整合性を確保します。

  • チェック制約: 入力されるデータが、値の範囲やパターンなどの特定の条件を満たすようにするルールを設定します。

  • 詳細オプション:システムのバージョン管理やメモリ最適化テーブルなど、より高度なプロパティや動作を構成できます。

デザイナー内の [作成としてのスクリプト] パネルには、テーブル デザインを反映して自動的に生成された T-SQL スクリプトが表示されます。 次のようなオプションがあります。

  • 公開: [公開] を選択して変更をデータベースに直接適用します。 このアクションでは、DacFX (データ層 Application Framework) を使用してスキーマの更新プログラムをデプロイします。

  • スクリプトのコピー:生成されたT-SQLスクリプトをプレビューパネルからコピーして手動実行するか、必要に応じてエディタで直接開いてさらなる調整や修正を行います。

テーブルデザイナー機能のスクリーンショット。

データの表示と編集

この機能を使うには、オブジェクト エクスプローラーでテーブルをダブルクリックするか、テーブルを右クリックしてコンテキストメニューを開き、「Edit Table Data」を選択します。

テーブルデータは新しいエディタータブ内のデータグリッドで開きます。内容は、設定されたページごとの行数に基づくページ操作で、馴染みのあるスプレッドシートのようなレイアウトで表示されます。

主な機能は次のとおりです。

  • インライン編集:グリッド内でセル値を直接更新できます。 編集内容はリアルタイムで検証され、無効なデータ型や制約違反など、正しくない入力のエラー メッセージが返されます。 正しくない入力が赤色のセルがグリッドで強調表示されます。

  • 行の追加と削除: 新しい行を挿入したり既存の行を削除したりすることで、開発やテスト中にデータを素早く調整できます。

  • ページネーション: 組み込みのページングコントロールを使って大規模なデータセットをナビゲートします。

  • 変更を保存:すべての編集は「 変更の保存」を選択するまで保留中のままなので、更新がデータベースにコミットされるタイミングを完全にコントロールできます。

  • スクリプト表示:このペインには、データグリッド上で実行されるすべてのアクションをリアルタイムで反映する読み取り専用のDMLスクリプトが表示されます。 スクリプトを使用して、変更を保存する前に、基になる DML 操作を確認します。

データ編集画面のスクリーンショット。

クエリ結果ペイン

Visual Studio Code の下部パネルに、統合ターミナル、出力、デバッグ コンソール、その他のツールと共にクエリ結果が表示されます。

ヒント

前のエクスペリエンスと同様に、展開ビューの新しいタブでクエリ結果を開くことができます。

[クエリ結果] ウィンドウの主な機能は次のとおりです。

  • グリッドビュー:クエリ結果を慣れたグリッド形式で表示し、簡単にデータを確認できます。 結果を新しいタブに表示して、より明確で整理されたビューを表示できます。

  • コピーオプション: 結果グリッド内で右クリックすると 「すべて選択」「コピー」「ヘッダー付きコピー」「ヘッダーをコピー」 などのオプションにアクセスでき、他の用途のためにデータを転送しやすくなります。

  • クエリ結果の保存:クエリ結果を JSON、Excel、CSV など複数の形式に保存できるため、Visual Studio Code 以外でもデータを扱うことができます。

  • インラインソート:クエリ結果ビューで列ヘッダーを直接選択することでデータを並べ替えることができます。 並べ替えを昇順または降順で行って、データの特定のサブセットを簡単に分析できます。

  • 推定プラン: 推定プラン ボタンは、クエリツールバーの「 クエリ実行」 ボタンの横にあるフローチャートアイコンとして表示されます。 クエリを実行せずに推定実行プランが生成されるため、クエリ オプティマイザーがクエリを処理する方法を確認できます。

  • 実際のプランを有効にする: 推定プランボタンの後にある「実際のプランを有効にする」ボタンは、実行されたクエリの実際のクエリプランを表示します。 ボトルネックと非効率性を特定するには、このオプションを使用します。

クエリ結果機能のスクリーンショット。

ヒント

mssql.openQueryResultsInTabByDefault設定を使用して、クエリ結果の動作をカスタマイズできます。 trueに設定すると、クエリ結果は既定で新しいタブで開き、ワークスペースを減らすことができます。

新しいResults Grid体験はプレビューで利用可能で、状態管理、パフォーマンス、列の固定、表示、非表示などのカラムカスタマイズの改善が含まれています。 既定では有効になっています。 この設定を変更するには、Visual Studio Code設定でmssql.preview.betaResultsGridを修正してください。

クエリ プラン ビジュアライザー

クエリ プラン ビジュアライザーには、SQL クエリの実行プランが表示されます。 クエリ オプティマイザーが各操作を処理する方法を示しているため、ボトルネックを特定し、クエリを最適化できます。

主な機能は次のとおりです。

  • ノードナビゲーション:実行計画の各ステップがノードとして表示されます。 プランはさまざまな方法で操作できます。 ノードを選択すると、特定の操作に関するヒントや詳細情報が表示されます。 ノード ツリーを折りたたむか展開して、ビューを簡略化し、クエリ プランの重要な領域に焦点を当てます。
  • ズームコントロール: ビジュアライザーは柔軟なズームオプションを提供し、プランを詳細に分析するのに役立ちます。 拡大または縮小して、詳細レベルを調整できます。 ズーム機能 を 使用してビューのサイズを変更し、プラン全体を画面に収めます。 特定の要素を正確に調べるためにカスタム ズーム レベルを設定します。
  • メトリクスとハイライト: 指標ツールバーは、主要なメトリックを分析し、コストの高い操作を強調するのに役立ちます。 実際 の経過時間、 コスト、 サブツリー コスト、またはドロップダウン リストから 読み取られた行数 などのメトリックを選択して、ボトルネックを特定します。 これらのメトリックを使用して、クエリ プラン内の特定のノードを検索して詳細な分析を行います。

右側のサイドバーでは、より多くのアクションにすばやくアクセスできます。

  • 計画を保存:現在の実行計画を将来の参照のために保存します。
  • XMLを開く:クエリプランのXML表現を開き、コードレベルで詳細を確認します。
  • クエリを開く:実行計画を生成したクエリをツールバーから直接表示します。
  • ツールチップを切り替える:各ノードの詳細を表示するには、ツールチップを有効または無効にできます。
  • プロパティ:実行計画内の各ノードのプロパティを表示でき、重要度またはアルファベット順に並べ替えるオプションがあります。

クエリプランビジュアライザー機能のスクリーンショット。

ショートカット設定

ショートカット設定を使って一般的なコマンドを管理・実行してください。

機能を使用するには、MSSQL拡張ツールバーから「 ショートカット設定を開く 」を選択してください。

MSSQL拡張機能ツールバーのスクリーンショットで、[ショートカット構成を開く]ボタンが表示されます。

2つのタブが含まれています:

  • クイッククエリ:キーボードショートカットでSQLスニペットを保存・実行できます。
  • 拡張ショートカット:MSSQLエディタおよび結果ビューショートカットを設定します。

クイッククエリタブには以下のオプションがあります:

  • カスタマイズ可能なSQLクエリ:複数のSQLクエリエントリを構成し保存します。
  • 自動実行コントロール:ショートカットがクエリを即座に実行するか、エディタで先に開くかを選択します。
  • キーバインディング統合: Visual Studio Code キーボードショートカットエディターでキーバインディングをカスタマイズできます。

クイッククエリタブにクエリスロット、自動実行オプション、キーバインディングコントロールが表示されたショートカット設定ページのスクリーンショット。

拡張機能ショートカットや高度なショートカット設定の詳細については、「キーボードショートカットのカスタマイズ」をご覧ください。

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

この拡張機能は現在、次のオペレーティング システムに対応しています。

  • Windows 10 および 11 (x64、Arm64)
  • macOS (Intel と Apple Silicon)
  • Linux (x64、Arm64) - Ubuntu、Debian、RHEL、Fedora、およびその他の主要なディストリビューションを含む

オフライン インストール

拡張機能は、アクティブ化中に必要な SqlToolsService パッケージをダウンロードしてインストールできます。 [拡張機能] ビューで [ VSIX からインストール]... オプションを選択し、[ リリース] ページからバンドルされたリリースをインストールすることで、インターネットにアクセスできないマシンで拡張機能を引き続き使用できます。 各オペレーティング システムには、必要なサービスが含まれる .vsix ファイルがあります。 ご使用の OS に対応するファイルを選択し、ダウンロードしてインストールしてから開始します。 完全なリリースを選択し、アルファ版またはベータ版のリリースは無視します。これらのバージョンはテストで毎日使用されるビルドです。

フィードバックとサポート

アイデアやフィードバックがある場合、またはコミュニティに参加したい場合は、 https://aka.ms/vscode-mssql-discussionsでディスカッションに参加してください。 バグを報告するには、 https://aka.ms/vscode-mssql-bugにアクセスしてください。 新しい機能を要求するには、 https://aka.ms/vscode-mssql-feature-requestに移動します。