Snowflake Extension for Visual Studio Code¶

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

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

1. Visual Studio Codeを開きます。

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

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

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 を選択するか、アクティビティバーの拡張ボタン をクリックすることもできます。

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

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

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

SnowSQL 構成ファイルでの Snowflake Extension for Visual Studio Code の使用¶

Snowflake Extension for Visual Studio Code では、接続構成をロードするために Snow SQL 構成ファイル を使用できます。

Snow SQL 構成ファイルを使用するように Snowflake Extension for Visual Studio Code を構成するには、次を実行します。

1. Activity Bar で、Snowflakeアイコンを選択します。

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

2. Username ドロップダウンを選択し、次に Sign in to another account を選択します。

3. Use SnowSQL Config を選択します。 Snowflake Extension for Visual Studio Code のVisual Studioコード設定ページが開き、 SnowSQL Config Path が選択された状態になります。

4. 有効な SnowSQL 構成ファイルへのパスを入力します。

アカウントドロップダウンが更新され、指定された構成ファイルで定義されているすべての接続が含まれます。

SQL ファイルを開く¶

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

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

   既存の SQL ファイルがない場合は、新しいファイルを作成できます。 File » New File を選択し、型 Snowflake SQL File のファイルを作成します。または、データベースエクスプローラーパネルの（）ボタンを選択して、新しい SQL ファイルを作成します。

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

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

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

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

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

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

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

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

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

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

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

クエリ履歴の使用¶

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

以前に実行したクエリ結果を調べるには、次を実行します。

1. Query History を展開します。

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

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

クエリ結果の使用¶

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

特定のクエリの表示を変更するには、次を実行します。

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

2. QUERY RESULTS で列を選択します。

3. 下矢印（↓）を選択し、 SORT A-Z （降順）、 Sort Z-A （昇順）、 Hide column "column name"、または Freeze columns up to "column name" のいずれかを選択します。

コンテンツの表示は適宜変更されます。

クエリの結果をディスクに保存するには、クエリに関連付けられたディスク（）またはダウンロード（）を選択します。コンテンツは、圧縮済みのgzip、またはコンマ区切りファイルとしてファイルに保存されます。

Snowpark Python関数のデバッグ¶

Snowpark Python関数をデバッグするには、次を実行します。

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

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

Pythonでの SQL の構文強調表示とオートコンプリート¶

Pythonコードで SQL の構文強調表示を追加するには、自動検出を有効にするか、コメントを使用して手動で SQL 文字列を示します。

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

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

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

Python文字列で 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 オートコンプリートを使う¶

Python文字列で SQL ステートメントのオートコンプリートを使用するには、次を実行します。

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

2. SQL ステートメントの作成を開始し、表示されるオートコンプリートの候補を確認します。

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

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

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

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

ステージの操作¶

Snowflake Extension for Visual Studio Code は、データベースエクスプローラーにおけるステージコンテンツの直接管理をサポートしています。できること:

• ステージ内のすべてのファイルをリストします。

  1. 特定のステージに移動します。

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

• PUT のように、ローカルファイルシステムからステージにファイルをアップロードします。

  1. ステージに移動し、アップロード（）を選択します。

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

  3. アップロードするファイルが含まれるフォルダーに移動し、1つ以上のファイルを選択してアップロードします。

• GET のように、ステージからローカルファイルシステムにファイルをダウンロードします。

  1. ステージに移動します。

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

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

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

• REMOVE のように、ステージからファイルを削除します。

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

  2. 関連付けられた削除ボタン（）を選択します。

変更ログの表示¶

拡張機能の変更ログを表示するには、 Show Change Log コマンドを使用することもできます。

1. 次を押して Command Palette を開きます。Macキーボードの場合は CMD+Shift+P。Windowsキーボードの場合は CTRL+Shift+P。

2. 次のコマンドを入力します。

   Show Change Log
   

   Copy

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

現在、次の拡張機能設定をプレビューできます。

拡張機能の設定を変更する¶

拡張機能の設定を変更するには、

1. Windows/Linuxでは、 File » Preferences » Settings を選択します。 . macOS では、 Code » Preferences » Settings を選択します。

2. Search settings テキストボックスに Snowflake と入力します。

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

4. Settings タブを閉じます。