snow helpers V1からV2へ¶

Snowpark、Streamlit、Native Appのプロジェクト定義ファイルをV1からV2に移行します。

構文¶

snow helpers v1-to-v2
  --accept-templates
  --migrate-local-overrides / --no-migrate-local-overrides
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes
  --decimal-precision <decimal_precision>

引数¶

なし

オプション¶

-t, --accept-templates: テンプレートの移行を許可します。デフォルト: false。
-l, --migrate-local-overrides / --no-migrate-local-overrides: snowflake.local.ymlの値をメインのプロジェクト定義にマージします。snowflake.local.ymlファイルは移行されず、代わりにその値が出力されたsnowflake.ymlファイルに反映されます。未設定でsnowflake.local.ymlが存在する場合、エラーが発生します。
--format [TABLE|JSON| JSON_EXT|CSV]: 出力形式を指定します。デフォルト: TABLE
--verbose, -v: ログレベル info 以上のログエントリを表示します。デフォルト: false。
--debug: ログレベル debug 以上のログエントリを表示します。デバッグログには追加情報が含まれます。デフォルト: false。
--silent: コンソールへの中間出力をオフにします。デフォルト: false。
--enhanced-exit-codes: 終了エラーコードをエラーのタイプによって区別します。デフォルト: false。
--decimal-precision INTEGER: Number of decimal places to display for decimal values. Uses Python's default precision if not specified. [env var: SNOWFLAKE_DECIMAL_PRECISION].

--help: このコマンドのヘルプテキストを表示します。

使用上の注意¶

Snowflake CLI 3.0 では、V2 プロジェクト定義ファイルのサポートが導入されました。既存のV1.xプロジェクト定義ファイルがある場合、 snow helpers v1-to-v2 コマンドを使って、ファイルをV2バージョンに変換することができます。このコマンドはオリジナル・バージョンを snowflake_V1.yml ファイルに保存します。

このコマンドは、 snowflake.yml ファイルと同じディレクトリで実行する必要があります。

注意

Snowflake CLI 3.0でのプロジェクト定義テンプレートの処理方法の変更に伴い、Snowflakeでは、テンプレートを使用したプロジェクト定義ファイルが変換後に正しく動作することを保証できません。デフォルトでは、テンプレートを含む1.xファイルを変換しようとすると、このコマンドはエラーを生成します。--accept-templates オプションを使えば、これらのタイプのファイルを強制的に変換させることができます。その後、手動でテンプレートをV2相当のものに更新する必要があります。

例¶

バージョン1.xのプロジェクト定義ファイルを変換します。
```
cd <project-directory>
snow helpers v1-to-v2
```
```
Project definition migrated to version 2.
```
バージョン2のプロジェクト定義ファイルを変換します。
```
cd <project-directory>
snow helpers v1-to-v2
```
```
Project definition is already at version 2.
```

--accept-templates オプションを指定せずに、テンプレートを含むバージョン1のプロジェクト定義を変換します。

cd <project-directory>
snow helpers v1-to-v2

+- Error---------------------------------------------------------------------+
| Project definition contains templates. They may not be migrated correctly, |
| and require manual migration.You can try again with --accept-templates     |
| option, to attempt automatic migration.                                    |
+----------------------------------------------------------------------------+

--accept-templates オプションを使ってバージョン1のプロジェクト定義を変換します。

cd <project-directory>
snow helpers v1-to-v2

WARNING  snowflake.cli._plugins.workspace.commands:commands.py:60 Your V1 definition contains templates. We cannot guarantee the correctness of the migration.
Project definition migrated to version 2