Native Application Frameworkにおける宣言型共有用のアプリケーションパッケージ¶
As a provider, you create an application package to bundle your data content and notebooks into a Declarative Native App. This topic explains what an app package is and describes the high-level steps to create one, from creating the initial package to adding your manifest and notebook files.
The application package and the live version¶
The app package is a container for all the files that make up the app, including the manifest file and any Snowflake Notebooks. When you create an app package, a live (staged) version of the app package is also created. The live version is a development workspace where you can add or update files, such as the manifest file and notebook files, and preview and test the experience before publishing.
Once you're satisfied with the live version of the app, you can commit the live version to create a new immutable version of the app package, that you can then publish.
Using the live version for development simplifies version management by maintaining a single immutable version of the app package that is ready to be published, and a single live version for development. The Snowflake Native App Framework automatically manages the versioning of the app package, so you don't need to manually track version numbers.
The Snowflake Native App Framework maintains a live version for any app package automatically. Even if you remove the live version, a new live version is created automatically from the last committed version of the app package.
アプリケーションパッケージを作成する¶
Providers develop and test an application (app) package. An app package includes files necessary to share the data in the app, and defines how data can be accessed by consumers.
プロセスには次のステップが含まれます。
Create an app package project (first time only): creates an app package project that will later be published. This also creates the live version of the app package.
Add content to the app package:
Create or update a manifest file: This file describes the app package and its contents.
Download notebook files. If notebooks are to be included, download a copy to be included in the app package.
Add the files to the live version of the app package.
Build the app package: allows you to verify that the manifest file is valid and that all links in the manifest file are correct.
Test the app. Install the app and try it out. Make changes, and rebuild.
Commit the app package: creates a new immutable version of the app that can be published.
Release the app package. With a released package, you can create a new listing, either privately or publicly on the Snowflake Marketplace.
このプロセスは「チュートリアル：Declarative Native Apps 入門」で説明されています。このセクションには、開発のさまざまなステージで利用可能なオプションの詳細が含まれています。
新しいアプリケーションパッケージの作成¶
First, create a new Declarative Native App package to hold the app's files, either via Snowsight or SQL commands from Snowflake CLI, using the snow://package/<DECL_SHARE_APP_PKG>/versions/LIVE/ URL scheme.
Snowsight を使用して新しいアプリパッケージを作成する方法は次のとおりです。
Sign in to Snowsight.
In the navigation menu, select Projects » App Packages.
Share Data + Code カードで、 Create を選択します。
アプリパッケージの名前を入力し、 Create を選択します。
Snowflake CLI の SQL を使用して新しいアプリパッケージを作成する方法は次のとおりです。
Create a Declarative Native App package using the CREATE APPLICATION PACKAGE ... TYPE=DATA command, replacing
<DECL_SHARE_APP_PKG>with the name you want to give the app package:
snow sql -q "CREATE APPLICATION PACKAGE <DECL_SHARE_APP_PKG> TYPE = DATA;"
The new empty app package is created. This also creates a live version of the app package that you can edit.
Assemble content for the application package¶
An app package includes the following components:
A manifest file (required): A text-based file that defines the app's structure.
Snowflake Notebook files (optional): One or more text-based files that can act as a front end to the consumer experience, referencing the shared views and tables. They can also include code, reference visualizations, and include logic to help present the data.
マニフェストファイルの作成または更新¶
You can create or update a manifest file, which describes the app package and its shared content--for example, notebooks, tables, and views. It defines other metadata, such as app roles included with the app.
The manifest file must be named manifest.yml, and must be added to the root level of the app package.
詳細については、 Declarative Native App マニフェストリファレンス をご参照ください。関連する:doc:`tutorials/getting-started`には、マニフェストファイルの例が含まれています。
ノートブックファイルの取得¶
If Snowflake Notebooks are to be included in the app, download a copy of each notebook file so you can include it in the app package.
Snowsight で：
ナビゲーションメニューで、Projects » :ui:`Notebooks`を選択し、その後ダウンロードするノートブックを選択します。
In the left pane, next to your notebook, select ... » Download.
ファイルは、:file:`<notebook_name>.ipynb`という名前のファイルとしてローカルマシンにダウンロードされます。.
注釈
ノートブック環境には、PythonやStreamlitなどのAnacondaパッケージがプリインストールされています。ノートブックが追加のAnacondaパッケージを使用する場合は、コンシューマーの環境で使用できるように、それらをパッケージとしてノートブックに追加する必要があります。ノートブックにAnacondaパッケージを追加する方法 については、「Add Anaconda packages to a notebook」を参照してください。
Add files to the live version¶
Add the manifest and notebook files to the live version of the app package:
Snowsight を使用してアプリパッケージに入力する:
If you're not already viewing the app package's listing, from the navigation menu, select Projects » App Packages, and then select the app package you want to add files to.
Upload files を選択します。（ファイルを置換または追加する場合は、 Manage files を選択し、 Upload files を選択します。）
ノートブックファイルとマニフェストをハードディスクから、指定された Upload files ダイアログにドラッグするか、 Browse を選択してファイルを見つけて選択します。
Upload を選択してライブステージにファイルをアップロードし、ビルドをトリガーします。
Snowflake CLI で SQL を使用してアプリパッケージを入力するには、以下のコマンドを使用し、ファイルパスを独自のものに置き換え、
<DECL_SHARE_APP_PKG>をアプリパッケージの名前に置き換えます。マニフェストファイル:
snow sql -q "PUT file:////Users/test_user/Documents/manifest.yml snow://package/<DECL_SHARE_APP_PKG>/versions/LIVE/ OVERWRITE=TRUE AUTO_COMPRESS=false;"
Notebook file:
snow sql -q "PUT file:////Users/test_user/Documents/NOTEBOOK.ipynb snow://package/<DECL_SHARE_APP_PKG>/versions/LIVE/ OVERWRITE=TRUE AUTO_COMPRESS=false;"
Verify the files are in the application package with the following command:
snow sql -q "LIST snow://package/<DECL_SHARE_APP_PKG>/versions/LIVE"
出力は、以下のようなライブバージョンのアプリパッケージのファイルを示しています。
+--------------------------------------------------------------------------------+ | name | size | md5 | last_modified | |-------------------------------+------+---------+-------------------------------| | /versions/live/manifest.yml | 304 | 843a... | Wed, 23 Jul 2025 08:27:26 GMT | | /versions/live/NOTEBOOK.ipynb | 832 | b014... | Wed, 23 Jul 2025 04:32:22 GMT | +--------------------------------------------------------------------------------+
Download a file from the application package¶
Snowflake CLI の :doc:`/sql-reference/sql/get`SQL コマンドを使用して、アプリパッケージからファイルをダウンロードできます。
now sql -q "GET snow://package/<package_name>/versions/LIVE/manifest.yml file://manifest.yml"
Remove content from the application package¶
You can remove files from the application package.
Using Snowsight:
If you're not already viewing the app package's listing, from the navigation menu, select Projects » App Packages, and then select the app package you want to remove files from.
Manage files » Remove files を選択します。
削除するファイルを選択し、 Delete を選択します。
Remove files ダイアログで、削除するファイルを選択し、 Remove & build を選択します。
Snowflake CLI の REMOVE（または RM ）SQL コマンドを使用する方法は次のとおりです。
snow sql -q "RM snow://package/<DECL_SHARE_APP_PKG>/versions/LIVE/manifest.yml"
アプリケーションパッケージをビルドします。¶
次に、アプリのテスト可能なバージョンをビルドします。
In Snowsight:
アプリパッケージにファイル一式をアップロードすると、ビルドが自動的に開始されます。
それ以外の時間にビルドを実行するには、アプリパッケージの ページにあるビルドボタンを選択します。
If there are any errors in the manifest file, the build fails and gives information on how to fix the error. Correct the errors and rebuild the app package.
ALTERAPPLICATIONPACKAGE ... BUILD コマンドはアプリパッケージのテスト可能なバージョンを構築し、マニフェストファイルが有効ですべてのリンクが機能することを確認します。
ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> BUILD;
If there are any errors in the manifest file, the build fails and gives information on how to fix the error. Correct those errors and rebuild the app package.
ビルドされたアプリはライブ状態を維持し、アプリケーションパッケージに引き続き変更を加えることができます。
スキップする¶
For updates that don't require further testing, you can skip ahead by building, committing, and releasing an app package all at once using the ALTER APPLICATION PACKAGE ... RELEASE LIVE VERSION command.
ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> RELEASE LIVE VERSION;
アプリケーションのテスト¶
After building the app package, you can perform basic tests on it from the live environment.
Install the app from an app package using the command: CREATE APPLICATION ... FROM APPLICATION PACKAGE, replacing <DECL_SHARE_APP> with the name of the app. For example:
CREATE APPLICATION <DECL_SHARE_APP> FROM APPLICATION PACKAGE <DECL_SHARE_APP_PKG>
Update the files in the app package as needed, and then see if it worked by using the command: ALTER APPLICATION PACKAGE ... UPGRADE USING VERSION LIVE.
ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> UPGRADE USING VERSION LIVE;
To test some features, such as app roles, you must first release a new version of the app package, and then test using a separate consumer account. For more information, see Declarative Native App をインストール and Declarative Native App のコンテンツへのアクセス.
オプション：ライブバージョンの編集のリセット¶
If the edits made to the live version of the app package are no longer needed, you can reset the app package to the state before the edits were made with the ALTER APPLICATION PACKAGE ... ABORT LIVE VERSION command.
ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> ABORT LIVE VERSION;
When you use the preceding command to remove the current live version, a new live version is created with the same contents as the last committed version of the app package. The live version is reset to the last committed version, and all changes made to the live version are discarded.
Commit and release the application package¶
Committing the app package builds a new immutable version of the app that can't be edited and is ready to be published. Releasing the app package does the following:
コミットされたアプリをコンシューマーと共有できるようにします。
プロバイダーがすでにコンシューマーとアプリを共有している場合、新しいバージョンがそれらのコンシューマーに自動的に利用可能になります。
If there's already a live version of the app on the Snowflake Marketplace, the new version is automatically available to consumers who have installed the app.
Snowsight を使用してアプリパッケージをコミットしてリリースする方法は次のとおりです。
If you're not already viewing the app package's listing, from the navigation menu, select Projects » App Packages, and then select the app package you want to release.
Commit & release を選択します。
確認ダイアログで、 Acknowledge & continue を選択します。
The committed app package is released, and the live version of the app package is removed. A new live version of the app package is created from the new committed version for further development.
アプリパッケージをコミットしてリリースすると、 Latest release タブにはリリースの内容が表示されます。これは前回のビルドの内容と同じです。
In SQL, use the ALTER APPLICATION PACKAGE commands as shown:
ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> COMMIT;
The live version of the app package is removed. A new live version of the app package is created from the new committed version for further development.
Next, release the committed app package:
ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> RELEASE;
You can also build, commit, and release a live version of the app package, all at once:
ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> RELEASE LIVE VERSION;
After you release the app package, you can create a new listing for the app, either privately or publicly on the Snowflake Marketplace. For more information, see 宣言型共有を使用してリストを作成する.