Paquets d’application dans le partage déclaratif du framework des applications natives

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.

Création d’un paquet d’application

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.

Ce processus comprend les étapes suivantes :

  1. 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.

  2. Add content to the app package:

    1. Create or update a manifest file: This file describes the app package and its contents.

    2. Download notebook files. If notebooks are to be included, download a copy to be included in the app package.

    3. Add the files to the live version of the app package.

  3. Build the app package: allows you to verify that the manifest file is valid and that all links in the manifest file are correct.

  4. Test the app. Install the app and try it out. Make changes, and rebuild.

  5. Commit the app package: creates a new immutable version of the app that can be published.

  6. Release the app package. With a released package, you can create a new listing, either privately or publicly on the Snowflake Marketplace.

Ce processus est décrit dans Tutoriel : Premiers pas avec Declarative Native Apps. Cette section inclut des détails supplémentaires sur les options disponibles aux différentes étapes du développement.

Schéma montrant les étapes de la création d'un paquet d'application : Ajouter un paquet actif, un build, une validation et une version. Le diagramme montre également les étapes facultatives pouvant être ignorées pour construire, valider et publier une version active en même temps.

Créer un nouveau paquet d’application

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.

To use Snowsight to create a new app package:

  1. Sign in to Snowsight.

  2. In the navigation menu, select Projects » App Packages.

  3. In the Share Data + Code card, select Create.

  4. Enter a name for your app package, and then select Create.

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.

Diagramme des composants du paquet d’application

Créer ou mettre à jour un fichier manifeste

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.

Pour plus d’informations, voir Référence du manifeste d’une Declarative Native App. Le Tutoriel : Premiers pas avec Declarative Native Apps asssocié comprend un exemple de fichier manifeste.

Create or update a manifest file from a Snowflake data share

Note

Le contenu suivant n’est pas pris en charge par Snowflake. L’ensemble du code est fourni « AS IS » et sans garantie.

Si vous disposez d’un partage de données existant dans Snowflake, vous pouvez créer automatiquement un fichier manifeste à l’aide de l’outil open-source Manifeste du partage. Cet outil fourni par Snowflake génère un fichier manifeste basé sur les objets d’un partage spécifié. L’outil comprend également des options pour personnaliser le fichier manifeste généré. Vous pouvez utiliser cet outil des manières suivantes :

  • Générez un fichier manifeste à l’aide de l’interface de ligne de commande (CLI).

  • Intégrez l’outil dans un flux de travail d’automatisation Python existant en tant que bibliothèque.

Pour plus d’informations sur la manière de télécharger et d’utiliser l’outil, voir le référentiel Manifeste Snowflake du partage sur GitHub.

Note

L’outil Manifeste du partage crée uniquement le fichier manifeste en utilisant les bases de données, les schémas, les tables et les vues du partage de données. L’outil n’inclut aucun autre objet dans le fichier manifeste généré.

Obtenir des fichiers 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.

Depuis Snowsight :

  1. Dans le menu de navigation, sélectionnez. Projects » Notebooks, puis sélectionnez le notebook que vous souhaitez télécharger.

  2. In the left pane, next to your notebook, select … » Download.

Le fichier est téléchargé sur votre machine locale, sous la forme d’un fichier nommé <notebook_name>.ipynb.

Note

L’environnement du notebook dispose d’un ensemble de packages Anaconda préinstallés, dont Python et Streamlit. Si votre notebook utilise des packages Anaconda supplémentaires, vous devez les ajouter en tant que packages à votre notebook afin qu’ils puissent être utilisés dans l’environnement du consommateur. Pour obtenir des informations sur la manière d’ajouter des packages Anaconda à votre notebook, consultez 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:

To use Snowsight to populate the app package:

  1. 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.

  2. Select Upload files. (If you are replacing or adding additional files, select Manage files, and then select Upload files.)

  3. Drag the notebook files and the manifest from your hard disk to the Upload files dialog where indicated, or select Browse to locate and select the files.

  4. Select Upload to upload the files to the live stage and trigger a build.

Download a file from the application package

You can download a file from the app package using the GET SQL command in Snowflake CLI:

now sql -q "GET snow://package/<package_name>/versions/LIVE/manifest.yml file://manifest.yml"
Copy

Remove content from the application package

You can remove files from the application package.

Using Snowsight:

  1. 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.

  2. Select Manage files » Remove files.

  3. Select the file(s) you want to remove, and then select Delete.

  4. In the Remove files dialog, choose the files to remove, and then select Remove & build.

Tester le paquet d’application

Next, build a testable version of the app.

In Snowsight:

  • When you upload a complete set of files to the app package, a build kicks off automatically.

  • To perform a build at any other time, select the Build button on the app package’s page.

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.

L’application créée reste en état actif et vous pouvez continuer à apporter des modifications au paquet d’application.

À ignorer !

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;
Copy

Tester l’application

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>
Copy

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;
Copy

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 Installer une Declarative Native App and Accéder au contenu d’une Declarative Native App.

En option : Réinitialiser les modifications sur une version active

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;
Copy

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:

  • Crée une application validée prête à être partagée avec des consommateurs.

  • Si le fournisseur a déjà partagé l’application avec des consommateurs, la nouvelle version est automatiquement disponible pour ces consommateurs.

  • 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.

To use Snowsight to commit and release the app package:

  1. 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.

  2. Select Commit & release.

  3. In the confirmation dialog, select 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.

Once you’ve committed and released the app package, the Latest release tab shows the contents of the release, which is the same as the contents of the last build.

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 Création d’une annonce à l’aide du partage déclaratif.

Langage: Français