snow app bundle¶

構文¶

snow app bundle
  --package-entity-id <package_entity_id>
  --app-entity-id <app_entity_id>
  --project <project_definition>
  --env <env_overrides>
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes

引数¶

なし

オプション¶

--package-entity-id TEXT

definition_version が 2 以上の場合に操作するパッケージ・エンティティの ID 。

--app-entity-id TEXT

definition_version が 2 以上の場合に操作するアプリケーション・エンティティの ID 。

-p, --project TEXT

Snowflakeプロジェクトが保存されているパス。デフォルトは現在の作業ディレクトリです。

--env TEXT

key=value の形式の文字列。テンプレートに使用されたenvセクションの変数を上書きします。デフォルト: []

--format [TABLE|JSON|JSON_EXT|CSV]

出力形式を指定します。デフォルト: TABLE

--verbose, -v

ログレベル info 以上のログエントリを表示します。デフォルト: false。

--debug

ログレベル debug 以上のログ エントリを表示します。デバッグログには追加情報が含まれます。デフォルト: false。

--silent

コンソールへの中間出力をオフにします。デフォルト: false。

--enhanced-exit-codes

終了エラーコードをエラーのタイプによって区別します。デフォルト: false。

--help

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

使用上の注意¶

snow app bundle コマンドは、 Snowflake Native App のすべての成果物を含む仮ローカルディレクトリを作成します。また、SnowparkのPythonコードから SQL スクリプトを自動生成することもできます。このコマンドは、 snow app deploy、 snow app run、 snow app version create コマンドによって自動的に呼び出されます。しかし、ステージにアップロードする前に、セットアップスクリプト、アーティファクト、生成された SQL を確認したい場合は、このコマンドを手動で実行することができます。SQL コード生成の詳細については、 設定された Snowflake Native App アーティファクトを含むローカルフォルダーの準備 をご参照ください。

• このコマンドは、 プロジェクト定義ファイル を使用して、プロジェクト・ディレクトリ内に作成する仮フォルダの名前を決定します。

  • デフォルトでは、 <project_directory>/output/deploy となります。このディレクトリはデプロイルートとも呼ばれ、後続のコマンドでステージにファイルがアップロードされると、ステージの構造がどのようになるかを反映します。

  • output/deploy の代わりに Snowflake CLI にカスタム名のフォルダを作成させたい場合は、 プロジェクト定義ファイル の アプリケーションパッケージ エンティティの deploy_root フィールドを指定することで可能です。

    注釈

    デプロイルートに関連パスを提供する必要があります。絶対パスは拒否されます。デプロイルート・パスはプロジェクト・ディレクトリ内に作成されます。

  • run snow app bundle、あるいは他のコマンドが bundle 機能性を使用するとデプロイルートは削除され再作成されるため、デプロイルートは仮ディレクトリです。

• snow app bundle は、 snow app deploy 、 snow app run 、 snow app version create コマンドの一部として自動的に呼び出されるため、デプロイルートの外でソースファイルのみに変更を加える必要があります。デプロイルートにあるファイルを変更すると、次にこれらのコマンドを呼び出したときに、そのファイルはソースファイルの最新の状態で上書きされます。

• git のようなバージョン管理システムを使用している場合、デプロイルートは頻繁に変更される可能性があるため、追跡しないように選択することができます。

• snow app bundle は、Javaファイルからjarファイルを作成するなど、成果物のビルドやコンパイルは行いません。プロジェクト定義ファイルで指定された成果物のみをコピーし、デプロイルートに追加してステージのディレクトリ構造を模倣します。

• snow app bundle は、ローカルファイルシステムにのみ影響するため、Snowflake アカウントへのアクセスは必要ありません。

• このコマンドは、 プロジェクト定義ファイル 内の アプリケーションパッケージ エンティティの artifacts に対して次のようなコピーおよびシンボリックリンク動作を行います。

  • ソースパス内のすべてのディレクトリ名もデプロイルートに作成されます。

  • ソースパス内のすべてのファイルは、デプロイルート内のこれらのディレクトリ内でシンボリックリンクされます。

  • デプロイルートにあるシンボリックリンクされたファイルの中には、そのファイルから SQL 、ハードリンクになるものがあります。詳細については、 設定された Snowflake Native App アーティファクトを含むローカルフォルダーの準備 をご参照ください。

  プロジェクト定義ファイルから、次の artifacts リストの例を考えてみましょう。

  entities:
    pkg:
      type: application package
      ...
      artifacts:
        - src: dir1/dir2/*
          dest: dest_dir1/dest_dir2/
        - src: dir8/dir9/file.txt
          dest: dest_dir8/dest_file.txt
    ...
  

  Copy

  ここで、プロジェクト・ルートの dir1/dir2 には、 dir3 や dir4 などのサブディレクトリがあり、 file3.txt や file4.txt などのファイルがあります。

  snow app bundle コマンドを実行すると、デプロイルートは以下のようになります。

  -- deploy_root
        -- dest_dir1
              -- dest_dir2
                    -- dir3
                        -- ... <entire directory tree of dir3>
                    -- dir4
                        -- ... <entire directory tree of dir4>
                    -- file3.txt
                    -- file4.txt
        -- dest_dir8
              -- dest_file.txt
  

  Copy

例¶

これらの例は、コードファイルに必要な変更を加え、 snowflake.yml または snowflake.local.yml ファイルに追加し、関連アーティファクトをビルドまはたコンパイルしたことを前提としています。

cd my_app_project
snow app bundle

コマンドの実行中に発生する様々なステップに関する情報が表示され、プロジェクト定義ファイルで指定された場所（デフォルト： my_app_project/output/deploy）に新しいディレクトリが作成されます。

簡単なユースケースを実際に見るには、以下のコマンドを使ってすぐに使えるテンプレートを活用することができます。

snow init my_app_bundle_project --template app_basic
cd "my_app_bundle_project"
snow app bundle
ls my_app_bundle_project/output/deploy