Snowparkチェックポイントを使用するための IDE のセットアップ

Snowflake Extension for Visual Studio Code は、Snowpark Checkpoints ライブラリをサポートし、フレームワークの使用感を向上させます。コードに挿入された collectvalidate ステートメントをきめ細かく制御し、変換されたコードの動作同等性アサーションのステータスをレビューします。

Snowpark チェックポイントの有効化

Snowparkチェックポイントを有効にするには、Snowflakeの拡張機能設定で Snowpark Checkpoints: Enabled をチェックします。

有効なチェックポイント

ビュー

先に説明したように、Snowpark Checkpointsプロパティを Enabled にセットすると、拡張機能で SNOWPARK CHECKPOINTS という新しいタブが開きます。ワークスペース内のすべてのチェックポイントが表示され、すべてのチェックポイントを有効/無効にしたり、個別にチェックポイントを有効/無効にしたり、ファイルからすべてのチェックポイントを消去したり、各チェックポイントをダブルクリックすると、そのチェックポイントが定義されているファイルやコード行に移動するなど、複数のアクションを実行できます。

すべてのチェックポイントの切り替え

Snowpark Checkpoints タブの右上にあるこのオプションは、すべてのチェックポイントで有効プロパティを切り替えます。

チェックポイントの切り替え

有効なチェックポイント:

チェックポイントの切り替え

チェックポイントを無効にすると、ランタイム時にチェックポイントがスキップされます。

チェックポイントの無効化

すべてのチェックポイントのクリーンアップ

Snowpark Checkpoints タブの右上にあります。これは、ワークスペース内の Jupyter Notebooks を含むすべての Python ファイルからチェックポイントを削除しますが、コントラクトとパネルからは削除しません。つまり、コマンド Snowflake: Restore All Checkpoints を使って復元できるのです。

チェックポイントの削除

ファイルにチェックポイントを挿入

ファイル内を右クリックすると、 Snowpark Checkpoints オプションを含むコンテキストメニューが表示され、 CollectionValidation チェックポイントを追加することができます。

コンテキストメニューのSnowparkチェックポイントオプション:

チェックポイントの追加

コレクター/バリデーターを追加しました:

コレクターとバリデーターのチェックポイント

単一のチェックポイントの実行

各チェックポイントの上に表示されているコードレンズオプションをクリックすると、1つのチェックポイントを実行できます。実行すると、進行状況を示す出力コンソールが表示され、終了すると結果表示が表示されます。コントラクトファイルでチェックポイントが無効になっていても、実行の時だけ有効になります。

単一のチェックポイントの実行

コントラクトファイルでエントリーポイントが宣言されていない場合、エラーメッセージ チェックポイントでエントリーポイントが見つかりません が表示されます。

エントリーポイントが見つかりません

有効化されたSnowparkチェックポイントをすべてファイルで実行

各ファイルの右上には、 Run all checkpoints from the current file ボタンがあります。

すべてのチェックポイントの実行

クリックすると、実行の進捗状況を表示する出力チャンネルが表示されます。

チェックポイントの進捗状況

タイムライン表示

チェックポイント実行結果のタイムラインを表示します。

タイムライン表示

コマンド

Snowparkチェックポイントでは以下のコマンドが利用可能です。使用するには、コマンドパレットに Snowflake: [command name] と入力してください。

Snowpark チェックポイントコマンド

コマンド

説明

Snowflakeチェックポイントの切り替え

すべてのチェックポイントの有効プロパティを切り替えます。

Snowflake: Snowpark チェックポイント プロジェクトの初期化

プロジェクトの初期化をトリガーし、コントラクトファイルが存在しない場合は作成します。それが存在する場合、チェックポイントをコントラクトファイルにロードするかどうかを尋ねるポップアップが表示されます。

Snowflake: すべてのチェックポイントをクリア

ワークスペース内のすべてのファイルからすべてのチェックポイントを削除します。

Snowflake: すべてのチェックポイントを復元

コントラクトファイルに残っているファイルから、以前に削除されたチェックポイントを復元します。

Snowflake:検証/収集チェックポイントの追加

バリデーターあるいはコレクターを、必須パラメーターとともにカーソル位置に追加します。

Snowflake Snowparkのチェックポイントを中心に表示

パネル SNOWPARK CHECKPOINTS にフォーカスを移します。

Snowflake:オープンチェックポイント タイムライン

チェックポイント実行のタイムラインを表示します。

Snowflake:現在のファイルからすべてのチェックポイントを実行

現在のファイルで有効になっているすべてのチェックポイントを実行します。

Snowflake:ワークスペース内のすべてのチェックポイントの実行

有効になっているすべてのチェックポイントをワークスペースから実行します。

Snowflake:すべてのSnowparkチェックポイントの結果を表示

すべてのチェックポイントの結果をタブに表示します。

警告

  • 重複:コレクション プロジェクトで、2 つのチェックポイントに同じ名前が割り当てられている場合、警告: 「同じ名前を持つ別のチェックポイントが検出されたため、上書きされます。」 が表示されます。 検証プロジェクトでは、同じ名前を持つ複数のチェックポイントがあっても、警告は表示されません。

  • タイプが違う:プロジェクトのタイプと異なるタイプのチェックポイントを追加すると、以下のエラーメッセージとともに下線が表示されます: 「正しいSnowpark-Checkpointsステートメントを使用しているか確認してください。この特定のチェックポイント・ステートメントは、このプロジェクトで使用されている他のステートメントとは異なります。「プロジェクトのタイプと一致しないステートメントは、実行時に無視されます。」

  • 無効なチェックポイント名: チェックポイント名のパラメーターを追加する方法が無効です。この場合、警告メッセージが表示されます: 「無効なチェックポイント名です。チェックポイント名は文字で始まり、文字、数字、ハイフン、アンダースコアのみを含むことができます」