Snowflake Extension for Visual Studio Code¶

SQL ファイルを開く、または作成する¶

1. VS コードで、 File > Open を選択し、 SQL ファイルの場所をブラウズして開きます。

   新しい SQL ファイルを作成するには、 File > New File を選択し、 Snowflake SQL File タイプのファイルを作成します。

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

3. オプション。 Snowflake: Execute All Statements () を選択してコマンドを実行します。

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

VS Codeで、以下のいずれかのオプションを選択します。

• ファイル内のすべての SQL ステートメントを実行するには、 Snowflake: Execute All Statements () を選択します。

• 特定のコマンドを実行するには、実行したいステートメントにカーソルを置き、 Execute を選択します。

• 複数のコマンドを実行するには、実行したいステートメントを選択し、 Execute を選択します。コマンドは上から順に実行されます。

キーボードショートカットを使ってステートメントを実行するには、実行したい SQL ステートメントを選択し、Macキーボードでは + [enter]、Windowsキーボードでは + [enter]を押します。

実行された SQL ステートメントの結果が SNOWFLAKE ペインに表示されます。

進行中のクエリをキャンセルするには、 QUERY HISTORY リストでクエリを選択し、 Cancel query () を選択します。

クエリ履歴を表示¶

1. VS Codeで、 Query History を展開します。

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

3. SNOWFLAKE ペインで結果を確認します。

4. オプション。次のいずれかを選択します。

   • Snowflake: Copy to Clipboard () を選択すると、クエリテキストがクリップボードにコピーされます。

   • クエリを削除するには、 Snowflake: Remove Query () を選択します。

クエリ結果の操作¶

クエリ結果は並べ替え、再並べ替え、非表示、凍結、またはディスクへの保存が可能です。

1. QUERY HISTORY でクエリを選択します。

2. UI:SNOWFLAKE ペインで列を選択します。

3. 展開矢印（↓）を選択し、次のいずれかを選択します。 Sort Ascending、 Sort Descending、 Hide column "column name"、または Freeze columns up to "column name"。

   列が以前に非表示になっていた場合は、他の列を選択して Unhide N columns を選択します。

4. オプション。次のいずれかを選択します。

   • Cloud () を選択すると、結果が圧縮されたgzipファイルとして保存されます。

   • Save () を選択して、結果をカンマ区切りの (CSV) ファイルとして保存します。

Snowpark Python関数のデバッグ¶

1. Python関数でSnowflakeストアドプロシージャを記述します。最初のパラメーターはSnowpark Session オブジェクトです。

2. インライン Snowflake: Debug オプションが関数名の上に表示されます。このオプションを選択すると、現在のアクティブなセッションを拡張機能で使用して、関数内のストアドプロシージャを実行します。デバッグ用のブレークポイントを設定することもできます。

SQL ステートメントの自動検出¶

自動 SQL 構文強調表示を設定するには、 拡張機能の設定 Auto Detect Sql in Python を有効にします。この拡張機能は、次の画像に示すように、Python文字列の最初の単語として、すべて大文字の SQL キーワードを探すことで、 SQL ステートメントを自動的に検出します。

SQL ステートメントを手動で示す¶

1. オプション。 延長設定 Auto Detect Sql in Python を無効にします。

2. コメントを使用して、 SQL ステートメントの開始と終了を示します。次のマーカーを自由に組み合わせて使用できます。

   • 開始マーカー: -–startsql、 -–beginsql、 -–start-sql、 -–begin-sql

   • 終了マーカー: –-endsql、 –-end-sql

   次の画像は、 --begin-sql と --end-sql のマーカーが、 SQL ステートメントを手動でどのように示すかを示しています。

Python文字列で SQL オートコンプリートを使う¶

1. Pythonファイルで、 VS Code拡張機能を使ってアクティブなSnowflakeセッションに接続しながら、Python文字列を作成します。

2. SQL ステートメントを記述します。オートコンプリート候補が表示されます。

   たとえば、 SELECT * FROM db1.public のようなステートメントを書き始めると、拡張機能から自動的にテーブル名が提案されます。

   同様に、テーブルを参照する SELECT ステートメント内で列を入力し始めると、次の画像のように、拡張機能から自動的に列名が提案されます。

Jinjaテンプレートの構文強調表示¶

デフォルトでは、 VS Code拡張機能は、次の画像に示すように、Snowflake SQL で Jinjaテンプレート を記述するための基本的な構文の強調表示とブラケットオートコンプリートを追加します。

VS コード拡張 Snowflake Native App コマンドパレットの表示¶

VS コード拡張 Snowflake Native App コマンドパレットは、以下の Snowflake Native App コマンドへのアクセスを提供します。

• Native Appsの作成

• Native Appsのデプロイ

• Native Apps表示に注力

• Native Appsを開く

• Native Appsの実行（デプロイと再インストール）

• Native Appの分解

これらのコマンドにアクセスするには、 VS Codeウィンドウの上部にある検索フィールドに「 >Snowflake Native 」とタイプします。

Snowflake Native App の作成¶

1. VS Codeで、Snowflake VS Code拡張機能を開き、Snowflakeにサインインします。

2. NATIVE APP ペインを展開し、 Create new from template を選択します。

3. 次のいずれかを選択します。

   • Snowflake Native App を作成するフォルダー名を入力し、 Enter を押します。

   • Enter を押して、デフォルトのディレクトリを Snowflake Native App の場所として受け入れます。

4. 次のいずれかを選択します。

   • Snowflake Native App テンプレートが保存されている GitHub リポジトリの URL を入力し、 Enter を選択します。

   • ローカルテンプレートフォルダのパスを入力します。

   • デフォルトの GitHub Snowflake Native App テンプレートリポジトリ URL を受け入れるには、 Enter を選択します。

5. 以下のテンプレートのいずれかを選択します。

   • 最小限のコード例とガイダンスで 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 Native App アプリケーションが利用可能な場合、プロンプトが表示され、デプロイに使用する snowflake.yml ファイルを選択できます。

Snowflake Native App をデプロイした後、Snowflakeでそれを開き、アクセス管理、アプリパッケージの表示、追加、検証、ログとイベントの表示、権限の変更を行うことができます。

1. 次のいずれかを選択します。

   • VS コード拡張 NATIVE APP ペインで、 Run (deploy and re-install) を選択します。これは、重要な変更を行い、アプリケーションオブジェクトが必要な場合に推奨されるオプションです。

   • VS コード拡張 NATIVE APP ペインで、 Deploy を選択します。これは、アプリケーションパッケージとステージファイルをデプロイし、アプリケーションオブジェクトが必要ない場合に推奨されるオプションです。

2. オプション。クエリ結果ペインで OUTPUT タブを選択し、デプロイの進捗を表示します。

3. NATIVE APP ペインで、 Open を選択します。

Snowflake Native App アプリケーションオブジェクトのステータスを表示する¶

• VS Code拡張機能 NATIVE APP ペインで、アプリケーションを展開します。

  青いフォントと青い丸は、アプリケーションオブジェクトがインストールまたはデプロイされていないことを示します。

Snowflake 環境変数マネージャの表示¶

環境変数プロファイルで環境変数を作成および管理するには、Snowflake 環境変数マネージャを使用します。環境変数プロファイルを使用して、 Snowflake Native App プロジェクト定義ファイルのオブジェクト動作をカスタマイズできます。例えば、開発環境、ステージング環境、本番環境でオブジェクトの動作を変更する環境変数プロファイルを作成できます。環境変数とSnowflake接続の詳細情報については、 プロジェクト定義ファイル をご参照ください。

Snowflake Environment Variables Manager を表示するには、次のいずれかの方法を使用します。

• VS コード拡張 NATIVE APP ペインで、 Environment Variables を選択します。

• コマンドパレットで、 Open Environment Variables Manager を選択します。

環境変数プロファイルへの環境変数の追加¶

環境変数プロファイルは環境変数を保存します。

1. VS コード拡張 NATIVE APP ペインで、 Environment Variables を選択します。

2. Selected Profile リストでプロファイルを選択します。

3. Environment Variable 列に環境変数を入力します。

4. Value 列に、環境変数の値を入力します。

5. オプション：環境変数プロファイルに追加の環境変数を追加するには、手順 3 と 4 を繰り返します。

6. オプション：環境変数プロファイルに追加の行を追加するには、 + (Add Row) を選択します。

環境変数プロファイルの追加¶

環境変数プロファイルは環境変数を保存します。 Snowflake Native App プロジェクト定義ファイルのオブジェクト動作をカスタマイズするには、新しいプロファイルを作成します。

1. VS コード拡張 NATIVE APP ペインで、 Environment Variables を選択します。

2. Add Profile を選択します。

3. プロファイルの名前を入力し、 Enter を押します。

環境変数プロファイルへの行の追加¶

環境変数を追加するには、環境変数プロファイルに行を追加します。

1. VS コード拡張 NATIVE APP ペインで、 Environment Variables を選択します。

2. Selected Profile リストからプロファイルを選択します。

3. + (Add Row) を選択します。

環境変数のプロファイル名の変更¶

1. VS コード拡張 NATIVE APP ペインで、 Environment Variables を選択します。

2. Selected Profile リストからプロファイルを選択します。

3. Rename Profile を選択します。

4. プロファイルの名前を入力し、 Enter を押します。

環境変数プロファイルの削除¶

1. VS コード拡張 NATIVE APP ペインで、 Environment Variables を選択します。

2. Selected Profile リストからプロファイルを選択します。

3. Delete Profile を選択します。

Snowflake Native App デバッグモードを有効にする¶

共有コンテンツ・オブジェクトや特定のデータベース・ロールに付与されていないオブジェクトなど、コンシューマーには表示されないアプリケーション・オブジェクトを表示するには、デバッグ・モードを使用します。デバッグモードとそれをプログラムでオンにする方法の詳細については、 デバッグモードを有効にする を参照してください。

• VS コード拡張 NATIVE APP ペインで、 App Debug Mode: OFF を選択します。

Snowflake Native App パッケージとアプリケーションオブジェクトをドロップする¶

Teardown オプションを使用して、解決されたプロジェクト定義で定義されたアプリケーションオブジェクトとパッケージをドロップします。

• VS コード拡張 NATIVE APP ペインで、 Teardown を選択します。ティアダウンが完了すると確認メッセージが表示されます。

ステージ内のすべてのファイルをリストする¶

1. VS Code OBJECT EXPLORER で、ステージに移動します。

2. ステージを展開すると、ステージングされたファイルすべてが表示されます。

ローカルファイルシステムからステージにファイルをアップロードする¶

Snowflake Extension for Visual Studio Code は内部ステージのアップロードのみをサポートしており、他のすべての操作は内部ステージと外部ステージの両方で機能します。

1. VS コード OBJECT EXPLORER で、ステージングに移動し、 Upload () を選択します。

2. アップロード操作のオプションのパラメーターを入力します。オプションのパラメーターリストについては、 PUT をご参照ください。

3. アップロードファイルを含むフォルダーに移動し、1つまたは複数のファイルを選択してアップロードします。

ステージからローカルファイルシステムにファイルをダウンロードする¶

1. VS Code OBJECT EXPLORER で、ステージに移動します。

2. Download () を選択してすべてのファイルをダウンロードするか、ステージを展開します。

3. ファイルを選択してダウンロードします。

4. ディレクトリを選択してダウンロードを完了します。

ステージからファイルを削除する¶

REMOVE もご参照ください。

1. VS Code OBJECT EXPLORER で、ステージに移動します。

2. ファイルを選択します。

3. Remove （）を選択します。

VS Code拡張機能プレビューの設定¶

次のテーブルは、 VS Code拡張機能プレビュー設定の一覧です。

VS Code拡張機能設定の変更¶

1. 次のいずれかを選択します。

   • Windows/Linux では、 File > Preferences > Settings を選択します。

   • macOS で Code > Settings > Settings を選択します。

2. Search settings フィールドに、 Snowflake と入力します。

3. ユーザー固有またはワークスペース固有の設定を表示または変更するには、 User または Workspace タブを選択します。

4. Settings タブを閉じます。