Pacotes de aplicativo no compartilhamento declarativo do 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.
Criação de um pacote de aplicativo¶
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.
Esse processo envolve as seguintes etapas:
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.
Esse processo é descrito em Tutorial: Introdução às Declarative Native Apps. Esta seção inclui mais detalhes sobre as opções disponíveis nas diferentes etapas de desenvolvimento.
Criação de um novo pacote de aplicativo¶
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.
Para usar o Snowsight para criar um novo pacote do app:
Sign in to Snowsight.
In the navigation menu, select Projects » App Packages.
No cartão Share Data + Code, selecione Create.
Insira um nome para o seu pacote do app e selecione Create.
Para usar SQL na CLI do Snowflake para criar um novo pacote do app:
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.
Criação ou atualização de um arquivo de manifesto¶
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.
Para obter mais informações, consulte Referência do manifesto Declarative Native App. O Tutorial: Introdução às Declarative Native Apps associado inclui um exemplo de arquivo de manifesto.
Obter arquivos de notebook¶
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.
Pelo Snowsight:
No menu de navegação, selecione Projects » Notebooks e depois o notebook que você quer baixar.
In the left pane, next to your notebook, select … » Download.
O arquivo é baixado na sua máquina local, com o nome <notebook_name>.ipynb.
Nota
O ambiente de notebook tem um conjunto de pacotes Anaconda pré-instalados, incluindo Python e Streamlit. Caso seu notebook use outros pacotes Anaconda, você deverá adicioná-los aos seus pacotes em seu notebook para que possam ser usados no ambiente do consumidor. Para saber como adicionar pacotes Anaconda ao seu notebook, consulte 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:
Para usar o Snowsight para preencher o pacote do app:
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.
Selecione Upload files. (Se você estiver substituindo ou adicionando arquivos, selecione Manage files e, em seguida, Upload files.)
Arraste os arquivos do notebook e o manifesto do seu disco rígido para a caixa de diálogo Upload files onde indicado ou selecione Browse para localizar e selecionar os arquivos.
Selecione Upload para carregar os arquivos para a área de preparação ativa e acionar uma compilação.
Para usar SQL no Snowflake CLI para preencher o pacote do app, use os comandos a seguir, substituindo os caminhos dos arquivos pelos seus próprios e
<DECL_SHARE_APP_PKG>pelo nome do pacote do app:Arquivo do manifesto:
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"
A saída mostra os arquivos na versão de produção do pacote do app, semelhante ao seguinte:
+--------------------------------------------------------------------------------+ | 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¶
Você pode baixar um arquivo do pacote do app usando o comando GET SQL no Snowflake CLI:
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.
Selecione Manage files » Remove files.
Selecione os arquivos que deseja remover e, em seguida, Delete.
Na caixa de diálogo Remove files, escolha os arquivos a serem removidos e, em seguida, selecione Remove & build.
Uso do comando SQL REMOVE (ou RM) no Snowflake CLI:
snow sql -q "RM snow://package/<DECL_SHARE_APP_PKG>/versions/LIVE/manifest.yml"
Criação do pacote de aplicativo¶
Em seguida, crie uma versão testável do app.
In Snowsight:
Quando você carrega um conjunto completo de arquivos para o pacote do app, uma compilação é iniciada automaticamente.
Para executar uma compilação a qualquer outro momento, selecione o botão Build na página do pacote do app.
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.
O comando ALTER APPLICATION PACKAGE … BUILD cria uma versão testável do pacote do app e verifica se o arquivo de manifesto é válido e se todos os links funcionam.
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.
O aplicativo criado permanece no estado ativo e você pode continuar fazendo alterações no pacote do aplicativo.
Pule para frente!¶
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;
Testagem do aplicativo¶
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 Instalação de um Declarative Native App and Acesso ao conteúdo de um Declarative Native App.
Opcional: Redefinição de edições em uma versão ativa¶
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:
Prepara um aplicativo confirmado para ser compartilhado com os consumidores.
Se o provedor já tiver compartilhado o aplicativo com os consumidores, a nova versão estará automaticamente disponível para eles.
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.
Para usar o Snowsight para confirmar e lançar o pacote do app:
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.
Selecione Commit & release.
Na caixa de diálogo de confirmação, selecione 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.
Depois de confirmar e lançar o pacote do app, a guia Latest release mostra o conteúdo do lançamento, que é o mesmo conteúdo da última compilação.
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 Criação de uma listagem usando compartilhamento declarativo.