Snowflake Extension for Visual Studio Code

Snowflake logo in black (no text) プレビュー機能 --- オープン

すべてのアカウントで利用可能です。

Snowflakeは Visual Studio Code （VS Code）の拡張機能を提供し、SnowflakeユーザーがSnowflake SQL ステートメントを VS Codeで直接記述および実行できるようにします。拡張機能はパッケージ化された機能であり、多くの場合サードパーティによって提供され、 VS Codeに新しい機能を追加します。

このトピックの内容:

Snowflake Extension for Visual Studio Code のインストール

Snowflakeユーザーは、Visual Studio Marketplaceから VS Code拡張機能を直接インストールするか、 .xsix ファイルとしてパッケージ化された拡張機能をダウンロードしてからインストールできます。

Visual Studio Marketplaceからのインストール

Visual Studio Marketplaceから直接インストールするには、次を実行します。

  1. Visual Studio Codeを開きます。

  2. Code » Preferences » Extensions を選択します。

    View » Extensions を選択するか、 VS Codeアクティビティバーの拡張ボタン vsc-extensions-button をクリックすることもできます。

  3. Search Extensions テキストボックスにテキスト Snowflake を入力して、Snowflake Visual Studio拡張機能を検索します。

  4. 拡張機能のセットから、Snowflakeによって作成された拡張機能を選択し、 Install をクリックします。

.vsixファイルからのインストール

.vsix ファイルからダウンロードしてインストールするには、次を実行します。

  1. 拡張機能をダウンロードします。

    1. Snowflake Visual Studio Code拡張機能 のページを開きます。

    2. Version History タブを選択します。

    3. ダウンロードするバージョンを選択し、 Download をクリックします。ファイルがダウンロードされた場所に注意してください。

  2. Visual Studio Codeを開きます。

  3. Code » Preferences » Extensions を選択します。

    View » Extensions を選択するか、アクティビティバーの拡張ボタン vsc-extensions-button をクリックすることもできます。

  4. 詳細（...）メニューから Install from VSIX を選択します。

    In the Extensions page, select more and then Install from VSIX file.

  5. 自分のコンピューターで snowflake-x.y.z.vsix ファイルを見つけ、ファイルを選択してから、 Install を選択します。

インストールが完了すると、 VS Codeの Extensions メニューの INSTALLED セクションに Snowflake Extension for Visual Studio Code が表示されます。

The Snowflake SQL extension, after being installed in Visual Studio Code.

サインイン

SQL ステートメントを実行する前に、Snowflakeアカウントにサインインする必要があります。

Snowflakeアカウント識別子、ユーザー名、およびパスワードを使用するか、 SAML SSO を使用してSnowflakeへのフェデレーション認証を使用して、Snowflakeにサインインできます。

VS Code拡張機能からSnowflakeに初めてサインインするときは、Snowflakeアカウントのアカウント識別子またはSnowflakeへの接続に使用する URL を入力して、アカウントを追加する必要があります。

アカウント識別子を確認する方法の詳細については、 アカウント識別子 をご参照ください。

VS Code拡張機能からSnowflakeにサインインするには、次を実行します。

  1. Activity Bar で、Snowflakeアイコンをクリックします。

    サイドバーパネルがSnowflakeナビゲーションに変わり、 Add Account または Sign in ダイアログが表示されます。

  2. Add Account で、アカウント識別子を入力して Continue を選択します。

    Add Account は、アカウントが以前に指定されていない場合にのみ表示されます。

    The Snowflake select account dialog.

  3. 選択したアカウントのユーザー名とパスワードを入力し、 Sign in を選択します。

サインインに成功すると、サイドバーが変更され、セッションコンテキスト（ACCOUNT）、デフォルトロールのユーザーの DATABASE EXPLORER、および QUERY HISTORY が表示されます。

SQL ファイルの操作

Snowflake Extension for Visual Studio Code を使用して、 SQL を作成し、ロードすることができます。SQL ファイルは、1つ以上の SQL ステートメントを含む単純なテキストファイルです。

SQL ファイルの開始

Snowflake SQL ファイルを作成または開くには、次を実行します。

  1. File » Open を選択し、 SQL を含むテキストファイルに移動して開きます。

    既存の SQL ファイルがない場合は、新しいファイルを作成できます。 File » New File を選択し、型 Snowflake SQL File のファイルを作成します。

    Alternatively, click the (vsc-new-sql-file-button) button in the Database explorer panel to create a new SQL file.

    The Snowflake SQL extension database explorer panel with new SQL file button highlighted.

  2. 1つ以上のSnowflake SQL ステートメントをファイルに追加します。

  3. 行を選択し、行の上で [実行] を押してコマンドを実行します。

コマンドまたはクエリの実行

1つ以上のコマンドまたはクエリを実行するには、次を実行します。

  1. 選択した SQL ファイルの vsc-execute-all-button を選択して、そのファイル内のすべてのステートメントを実行します。

  2. 実行するステートメントにカーソルを置いて、実行する行を選択します。

    2つ以上のコマンドを選択すると、選択したすべてのコマンドが実行されます。

  3. 選択した最初のコマンドの上にある [実行] ボタンを押します。

複数のコマンドを選択すると、コマンドは上から順に実行されます。

キーボードショートカットを使用してステートメントを実行することもできます。実行する SQL ステートメントを選択したら、Macキーボードでは Apple OSX Command key. + [enter]キーを、Windowsキーボードでは Generic control key. + [enter]キーを押します。

Output セクションの SNOWFLAKE:QUERY RESULTS テーブルで、 SQL ステートメントの結果を確認できます。

ちなみに

処理中のクエリはキャンセルできます。処理中のクエリをキャンセルするには、 QUERY HISTORY でクエリを見つけて、クエリのキャンセル（vsc-cancel-query-button）を押します。

クエリ履歴の使用

クエリ結果は QUERY HISTORY で追跡されます。

クエリ結果を表示するには、次を実行します。

  1. Query History を展開します。

  2. ステートメントを選択します。

  3. Output ペインの SNOWFLAKE:QUERY RESULTS タブで結果を調べます。

Example of executing a statement with result highlighted.

ちなみに

Query History を使用して、クエリを再実行（vsc-query-rerun-button）したり、クエリテキストをクリップボードにコピー（vsc-query-copy-button）したり、クエリを削除（vsc-query-delete-button）したりすることができます。

セッションコンテキストの変更

Side Bar パネルの Account セクションを使用して、ロール、データベース、スキーマ、ウェアハウスを選択できます。関連するドロップダウンを使用して、それぞれを適切に選択します。

The Snowflake sign in dialog.

ちなみに

アカウントドロップダウンを使用してサインインするか、別のアカウントに切り替えます。

Sign in to, or switch between accounts.

拡張機能の詳細を表示する

Snowflake SQL Visual Studio Code拡張情報はいつでも表示できます。

拡張機能に関する次の詳細を確認できます。

  • バージョン情報: 現在インストールされている拡張機能のバージョン。

  • 変更ログ: 追加、変更、または更新された機能に関するバージョンごとの情報。

  • 機能の手引き。

さらに、有効/無効ドロップダウンを使用して、拡張機能を無効または有効にすることができます。

拡張情報を表示するには、次を実行します。

  1. Code » Preferences » Extensions を選択します。

  2. Snowflake VS Code SQL 拡張機能を選択します。

    View » Extensions を選択するか、 Activities バーの拡張ボタン vsc-extensions-button をクリックすることもできます。

拡張機能のアンインストール

拡張機能を無効化またはアンインストールするには、次を実行します。

  1. Code » Preferences » Extensions を選択します

  2. 拡張機能を選択します。

  3. 右クリックして Disable または Uninstall を選択します。

言語: 日本語