Snowflake Extension for Visual Studio Code¶
Snowflake Visual Studio Code （VS Code）拡張機能を使用すると、Snowflake SQL ステートメントを VS Codeで直接記述および実行できます。この拡張機能は Snowpark Python とも統合され、Pythonコードでの SQL のデバッグ、構文の強調表示、オートコンプリート機能を提供します。
Visual Studio Marketplaceから VS Code拡張機能をインストールするか、 .vsix ファイルをダウンロードしてインストールできます。
このトピックの内容:
Visual Studio Marketplaceから VS Code拡張機能をインストールする¶
VS Codeで、 Code » Settings » Extensions を選択します。
Search Extensions in Marketplace フィールドに Snowflake と入力し、 Snowflake 拡張機能を選択します。
正しい拡張機能を選択したことを確認するには、以下の画像に示すような、Snowflakeのバッジを探します。
Install をクリックします。
.vsixファイルから VS Code拡張機能をインストールする¶
拡張機能をダウンロードします。
https://marketplace.visualstudio.com/items?itemName=snowflake.snowflake-vsc に移動します。
Version History タブをクリックします。
インストールしたい VS Codeバージョンの Download をクリックします。ファイルがダウンロードされた場所に注意してください。
VS Codeで、 Code » Settings » Extensions を選択します。
More (...) » Install from VSIX をクリックします。
コンピュータ上の
snowflake-x.y.z.vsixファイルの場所を参照し、ファイルを選択し、 Install を選択します。インストールが完了すると、 VS Codeの Extensions メニューの INSTALLED セクションに Snowflake Extension for Visual Studio Code が表示されます。
VS Code拡張機能を使ってSnowflakeにサインインする¶
SQL ステートメントの実行、またはSnowpark Pythonの機能を使用する前に、Snowflakeアカウントにサインインする必要があります。
VS Code拡張機能を使ってSnowflakeにサインインするには、以下の方法があります。
Snowflakeアカウントの識別子、ユーザー名、パスワードを使用します。
セキュリティアサーションマークアップ言語（SAML）やシングルサインオン（SSO）などのフェデレーション認証を使用します。
キーペア認証を使用します。
Snowflakeにサインインするために VS Code拡張機能を初めて使用する場合、Snowflakeアカウントのアカウント識別子またはSnowflakeに接続するために使用する URL を入力する必要があります。アカウント識別子を確認するには、 アカウント識別子 を参照してください。
VS CodeアクティビティバーのSnowflakeアイコンをクリックします。
Account Identifier/URL フィールドに、Snowflakeアカウントのアカウント識別子、またはSnowflakeへの接続に使用する URL を入力し、 Continue をクリックします。
Account Identifier/URL フィールドは、以前にSnowflakeアカウントの認証情報を提供した場合は使用できません。
Auth Method リストで、以下のオプションのいずれかを選択します。
Single sign-on を選択し、 SSO の認証情報を使用してSnowflakeにサインインします。
Username/password を選択し、Snowflakeのユーザー名とパスワードを使用してSnowflakeにサインインします。
Key Pair を選択し、Snowflakeのユーザー名とパスワードを使用してSnowflakeにサインインします。キーペア認証の詳細については、 キーペア認証とキーペアローテーション を参照してください。
認証情報を入力し、 Sign in をクリックします。
SSO を選択すると、ユーザー名を入力して Sign in with single sign-on を選択した後に、別の認証ページが開きます。SSO の認証情報を入力し、 VS Codeに戻ってSnowflakeのサインインを完了します。
サインインに成功すると、サイドバーにアカウント情報、デフォルトのロール、 データベース リストが表示された OBJECT EXPLORER、および QUERY HISTORY が表示されます。
Snowflake connections.toml ファイルを編集する¶
接続定義は、Snowflake connections.toml 設定ファイルで追加および変更できます。接続定義とは、接続に関連するパラメーターのコレクションのことです。TOML ファイルを使用したSnowflakeへの接続の詳細については、 connections.toml ファイルを使用した接続 を参照してください。
VS Codeで、Snowflake VS Code拡張機能を開き、Snowflakeにサインインします。
ACCOUNT ペインの Snowflake:Edit Connections File をクリックします。
TOML ファイルを編集します。
TOML ファイルを閉じ、 Save を選択します。
VS Code拡張機能インターフェイス¶
次のテーブルは、 VS Code拡張機能インターフェイス機能領域の説明です。
アイテム |
説明 |
|---|---|
1 |
サイドバーパネル。 アカウント、 オブジェクトエクスプローラー、 クエリ履歴 ペインが含まれます。このパネルを使用して、アカウントの詳細を指定し、データベースオブジェクトを調べ、クエリ結果を調べます。 |
2 |
Snowflake SQL パネル。Snowflake SQL ファイルを表示します。 |
3 |
クエリ履歴パネル。最近のクエリを表示します。 |
4 |
クエリ結果パネル。クエリ結果を表示します。クエリを選択すると、その実行結果が表示されます。 |
5 |
現在のセッション。現在のロール、データベース、スキーマ、アクティブなウェアハウスなど、現在のセッション情報を表示します。 |
SnowSQL 設定ファイルで VS Code拡張機能を使用する¶
Snowflake Extension for Visual Studio Code では、接続構成をロードするために Snow SQL 構成ファイル を使用できます。
注釈
接続構成値のみが使用されます。他の SnowSQL 構成値は無視されます。
VS Code検索フィールドで、
>user settingsと入力し、 Preferences: Open User Settings を選択します。User タブで、 Extensions を展開します。
下にスクロールして、 Snowflake を選択します。
右側のペインで、 Snowsql Config Path までスクロールダウンします。
有効な SnowSQL 構成ファイルへのパスを入力します。
設定で定義されたすべての接続は、 アカウント パネルに表示されます。
SQL ファイルの操作¶
Snowflake Extension for Visual Studio Code を使用して、 SQL を作成し、ロードすることができます。SQL ファイルは、1つ以上の SQL ステートメントを含むテキストファイルです。
SQL ファイルを開く、または作成する¶
VS Codeで、 File » Open を選択し、 SQL ファイルの場所を参照して開きます。
新しい SQL ファイルを作成するには、 File » New File を選択し、 Snowflake SQL File タイプのファイルを作成します。
1つ以上のSnowflake SQL ステートメントをファイルに追加します。
（オプション） Snowflake: Execute All Statements （
）をクリックしてコマンドを実行します。
コマンドまたはクエリの実行¶
重要
Snowflakeのクエリ結果を表示するために、 VS Code拡張機能は、すべてのクエリの後にバックグラウンドで自動的に DESC RESULT '<query_id>' を実行します。このプロセスは、 LAST_QUERY_ID() を不正確なものにします。DESCRIBE RESULT コマンドとそのパラメーターの詳細については、 DESCRIBE RESULT を参照してください。
VS Codeで、以下のいずれかのオプションを選択します。
ファイル内のすべての SQL ステートメントを実行するには、 Snowflake: Execute All Statements （
）をクリックします。特定のコマンドを実行するには、実行したいステートメントにカーソルを置き、 Execute をクリックします。
複数のコマンドを実行するには、実行したいステートメントを選択し、 Execute をクリックします。コマンドは上から順に実行されます。
キーボードショートカットを使ってステートメントを実行するには、実行したい SQL ステートメントを選択し、Macキーボードでは 
+ [enter]、Windowsキーボードでは 
+ [enter]を押します。
実行された SQL ステートメントの結果が SNOWFLAKE パネルに表示されます。
進行中のクエリをキャンセルするには、 QUERY HISTORY リストでクエリを選択し、 Cancel query （
）をクリックします。
クエリ履歴を表示¶
VS Codeで、 Query History を展開します。
ステートメントを選択します。
SNOWFLAKE パネルで結果を確認します。
（オプション）次のいずれかを選択します。
Snowflake: Copy to Clipboard （
）をクリックして、クエリテキストをクリップボードにコピーします。クエリを削除するには、 Snowflake: Remove Query （
）をクリックします。
クエリ結果の操作¶
クエリ結果は並べ替え、再並べ替え、非表示、凍結、またはディスクへの保存が可能です。
QUERY HISTORY でクエリを選択します。
SNOWFLAKE パネルで、列を選択します。
展開矢印（↓）を選択し、次のいずれかを選択します。 Sort Ascending、 Sort Descending、 Hide column "column name"、または Freeze columns up to "column name"。
列が以前に非表示になっていた場合は、他の列を選択して Unhide N columns を選択します。
（オプション）次のいずれかを選択します。
Cloud （
）をクリックして、結果をgzip圧縮ファイルとして保存します。Save （
）をクリックして、結果をコンマ区切りの（CSV）ファイルとして保存します。
Snowpark Pythonコードの使用¶
プレビュー機能 --- オープン
すべてのアカウントで利用可能です。Snowpark Pythonの VS コード拡張機能を使用するには、拡張機能の設定 Enable Public Preview Features を有効にする必要があります。詳細については、 VS Code拡張機能プレビューの設定 をご参照ください。
Snowflake Extension for Visual Studio Code を使用して、Snowpark PythonコードにSnowflakeの SQL ステートメントを記述し、デバッグできます。
Snowpark Python関数のデバッグ¶
Python関数でSnowflakeストアドプロシージャを記述します。最初のパラメーターはSnowpark
Sessionオブジェクトです。インライン Snowflake: Debug オプションが関数名の上に表示されます。このオプションを選択すると、現在のアクティブなセッションを拡張機能で使用して、関数内のストアドプロシージャを実行します。デバッグ用のブレークポイントを設定することもできます。
SQL ステートメントの自動検出¶
自動 SQL 構文強調表示を設定するには、 拡張機能の設定 Auto Detect Sql in Python を有効にします。この拡張機能は、次の画像に示すように、Python文字列の最初の単語として、すべて大文字の SQL キーワードを探すことで、 SQL ステートメントを自動的に検出します。
SQL ステートメントを手動で示す¶
（オプション） 拡張機能の設定 Auto Detect Sql in Python を無効にします。
コメントを使用して、 SQL ステートメントの開始と終了を示します。次のマーカーを自由に組み合わせて使用できます。
開始マーカー:
-–startsql、-–beginsql、-–start-sql、-–begin-sql終了マーカー:
–-endsql、–-end-sql
次の画像は、
--begin-sqlと--end-sqlのマーカーが、 SQL ステートメントを手動でどのように示すかを示しています。
Python文字列で SQL オートコンプリートを使う¶
Pythonファイルで、 VS Code拡張機能を使ってアクティブなSnowflakeセッションに接続しながら、Python文字列を作成します。
SQL ステートメントを記述します。オートコンプリート候補が表示されます。
たとえば、
SELECT * FROM db1.publicのようなステートメントを書き始めると、拡張機能から自動的にテーブル名が提案されます。同様に、テーブルを参照する SELECT ステートメント内で列を入力し始めると、次の画像のように、拡張機能から自動的に列名が提案されます。
Jinjaテンプレートの構文強調表示¶
デフォルトでは、 VS Code拡張機能は、次の画像に示すように、Snowflake SQL で Jinjaテンプレート を記述するための基本的な構文の強調表示とブラケットオートコンプリートを追加します。
Snowflake Native App Framework を使用した作業¶
プレビュー機能 --- オープン
すべてのアカウントで利用可能です。Snowpark Pythonの VS コード拡張機能を使用するには、拡張機能の設定 Enable Public Preview Features を有効にする必要があります。詳細については、 VS Code拡張機能プレビューの設定 をご参照ください。
VS Code拡張を使用して、 Snowflake Native App を作成したり、管理したりできます。 Snowflake Native App Framework の詳細については、 Snowflake Native App Frameworkについて を参照してください。
Snowflake Native App の作成¶
VS Codeで、Snowflake VS Code拡張機能を開き、Snowflakeにサインインします。
NATIVE APP ペインを展開し、 Create new from template をクリックします。
次のいずれかを選択します。
Snowflake Native App を作成するフォルダー名を入力し、 Enter を押します。
Enter を押して、デフォルトのディレクトリを Snowflake Native App の場所として受け入れます。
次のいずれかを選択します。
Snowflake Native App テンプレートが保存されている GitHub リポジトリの URL を入力し、 Enter を押します。
Enter を押して、デフォルトの GitHub Snowflake Native App テンプレートリポジトリ URL を受け入れます。
以下のテンプレートのいずれかを選択します。
最小限のコード例とガイダンスで Snowflake Native App を作成するには、 basic を選択します。
streamlit-python を選択すると、Python拡張コードとStreamlitコード例を含む Snowflake Native App が作成されます。
streamlit-java を選択して、Java拡張コードとStreamlitコード例を含む Snowflake Native App を作成します。
spcs-basic を選択して、 SPCS 拡張コードとStreamlitコード例を含む Snowflake Native App を作成します。
Snowflake Native App をデプロイし、開く¶
Run (deploy and re-install) または Deploy オプションを使用する場合、 NATIVE APP ペインにリストされた最初の snowflake.yml ファイルが使用されます。複数の snowflake.yml ファイルが利用可能な場合、プロンプトが表示され、配置に使用する snowflake.yml ファイルを選択できます。
Snowflake Native App をデプロイした後、Snowflakeでそれを開き、アクセス管理、アプリパッケージの表示、追加、検証、ログとイベントの表示、権限の変更を行うことができます。
次のいずれかを選択します。
VS Code拡張機能 NATIVE APP ペインで、 Run (deploy and re-install) をクリックします。これは、重要な変更を行い、アプリケーションオブジェクトが必要な場合に推奨されるオプションです。
VS Code拡張機能 NATIVE APP ペインで、 Deploy をクリックします。これは、アプリケーションパッケージとステージファイルをデプロイし、アプリケーションオブジェクトが必要ない場合に推奨されるオプションです。
（オプション）クエリ結果パネルの OUTPUT タブをクリックし、デプロイの進捗状況を表示します。
NATIVE APP ペインで、 Open をクリックします。
Snowflake Native App アプリケーションオブジェクトのステータスを表示する¶
VS Code拡張機能 NATIVE APP ペインで、アプリケーションを展開します。
アンインストールされたアプリケーションオブジェクトは青で表示されます。
デバッグモードを有効にする¶
コンシューマーには見えないアプリケーションオブジェクトを表示するには、デバッグモードを使用します。例えば、共有コンテンツオブジェクトや、特定のデータベースロールに付与されていないオブジェクトなどです。デバッグモードとそれをプログラムでオンにする方法の詳細については、 デバッグモードを有効にする を参照してください。
VS Code拡張機能 NATIVE APP ペインで、 Debug Mode をクリックします。
Enable Debug Mode をクリックします。
Enable debug mode for all Native Apps operations を選択します。
Snowflake Native App パッケージとアプリケーションオブジェクトをドロップする¶
Teardown オプションを使用して、解決されたプロジェクト定義で定義されたアプリケーションオブジェクトとパッケージをドロップします。
VS Code拡張機能 NATIVE APP ペインで、 Teardown をクリックします。ティアダウンが完了すると確認メッセージが表示されます。
セッションコンテキストの変更¶
Side Bar パネルの Account セクションを使用して、ロール、データベース、スキーマ、ウェアハウスを選択できます。関連するドロップダウンを使用して、それぞれを適切に選択します。
アカウントドロップダウンを使用してサインインするか、別のアカウントに切り替えます。
オブジェクトエクスプローラーでナビゲート¶
Side Bar パネルの OBJECT EXPLORER セクションを使用して、データベースオブジェクトの特性を調べて表示します。
アカウントにサインインします。
OBJECT EXPLORER を展開します。
データベースリストを展開します。
データベースを展開します。
スキーマを展開します。
子コンポーネントに移動します。
SNOWFLAKE Query Results パネルでその特性を表示するには、任意の要素を選択します。
（オプション）次のいずれかを選択します。
Open data preview （
）をクリックすると、テーブル、ビュー、マテリアライズドビュー、または同様のオブジェクトに関連付けられたコンテンツの最大100行のプレビューが表示されます。Show SQL （
）をクリックすると、オブジェクトに関連する SQL コードが表示されます。
ステージコンテンツの管理¶
Snowflake Extension for Visual Studio Code は、オブジェクトエクスプローラーにおけるステージコンテンツの直接管理をサポートしています。
ステージ内のすべてのファイルをリストする¶
VS Code OBJECT EXPLORER で、ステージに移動します。
ステージを展開すると、ステージングされたファイルすべてが表示されます。
ローカルファイルシステムからステージにファイルをアップロードする¶
Snowflake Extension for Visual Studio Code は内部ステージのアップロードのみをサポートしており、他のすべての操作は内部ステージと外部ステージの両方で機能します。
VS Code OBJECT EXPLORER でステージに移動し、 Upload （
）をクリックします。アップロード操作のオプションのパラメーターを入力します。オプションのパラメーターリストについては、 PUT をご参照ください。
アップロードファイルを含むフォルダーに移動し、1つまたは複数のファイルを選択してアップロードします。
ステージからローカルファイルシステムにファイルをダウンロードする¶
VS Code OBJECT EXPLORER で、ステージに移動します。
すべてのファイルをダウンロードするには、 Download （
）をクリックするか、ステージを展開してください。ファイルを選択してダウンロードします。
ディレクトリを選択してダウンロードを完了します。
ステージからファイルを削除する¶
REMOVE もご参照ください。
VS Code OBJECT EXPLORER で、ステージに移動します。
ファイルを選択します。
Remove （
）をクリックします。
VS Code拡張機能の設定¶
次のテーブルは、 Snowflake Extension for Visual Studio Code の設定一覧です。
設定 |
説明 |
デフォルト |
|---|---|---|
CSV をエクスポート » 区切り文字 |
列の区切り文字を指定します |
コンマ |
CSV をエクスポート » ヘッダー |
エクスポートされた CSV ファイルにヘッダー行を含めます |
有効化 |
CSV をエクスポート » 空の行を含める |
エクスポートされた CSV ファイルに空の行を含めます |
除外 |
CSV をエクスポート » 引用符 |
エクスポートされた CSV ファイル内のすべての値が二重引用符で囲まれます |
有効化 |
クエリをハイライト |
現在の SQL ステートメントで背景をハイライトします |
有効化 |
ステートメントの上に実行を表示する |
各ステートメントの上でクリック可能な実行アクションを有効にします |
有効化 |
Snowsql構成パス |
設定すると、接続構成がこのファイルからロードされます |
設定解除 |
オートコンプリートオブジェクトの詳細 |
オートコンプリートエントリーを選択した後に、Snowflakeオブジェクトの詳細を表示します |
無効化 |
クライアントセッションキープアライブの設定 |
アクティビティに関係なく、接続がアクティブである限り、セッションを無期限にアクティブにしておくかどうかを指定します。有効になっていない場合、4時間操作がないと再度サインインする必要があります。 |
有効化 |
オートコンプリートバリアントキー |
OBJECT/VARIANT キーのオートコンプリート候補を表示します |
無効化 |
オブジェクトエクスプローラー: 検索 |
オブジェクトエクスプローラーで検索を有効にします |
有効化 |
クエリ履歴: アイテム制限 |
履歴に表示されるクエリの最大数を指定します。より多くのクエリを表示すると、パフォーマンスに影響する可能性があります。 |
1000 |
VS Code拡張機能プレビューの設定¶
プレビュー機能 --- オープン
すべてのアカウントで利用可能です。
次のテーブルは、 VS Code拡張機能プレビュー設定の一覧です。
設定 |
説明 |
デフォルト |
|---|---|---|
構文の強調表示: PythonでSqlを自動検出する |
Python文字列の SQL ステートメントの自動構文強調表示を有効にします |
有効化 |
パブリックプレビュー機能を有効にする |
拡張機能のパブリックプレビュー機能を有効にします |
無効化 |
VS Code拡張機能設定の変更¶
次のいずれかを選択します。
Windows/Linuxでは、 File » Preferences » Settings を選択します。
macOS で Code » Settings » Settings を選択します。
Search settings フィールドに、 Snowflake と入力します。
ユーザー固有またはワークスペース固有の設定を表示または変更するには、 User または Workspace タブを選択します。
Settings タブを閉じます。
VS Code拡張機能の変更履歴を表示する¶
CMD+Shift+P （Mac）または CTRL+Shift+P （Windows）を押します。
次のコマンドを入力します。
Show Change Log
VS Code拡張機能をアンインストールする¶
Code » Settings » Extensions を選択します
拡張機能を選択します。
右クリックして、 Disable または Uninstall を選択します。