Anwendungspakete bei deklarativer Freigabe im Native Application Framework

Als Anbietender erstellen Sie ein Anwendungspaket, das Ihre Dateninhalte und Notizbücher in einer Declarative Native App bündelt. In diesem Thema wird erklärt, was ein Anwendungspaket ist, und es werden die allgemeinen Schritte zur Erstellung eines solchen Pakets beschrieben, von der Erstellung des ersten Pakets bis zum Hinzufügen Ihrer Manifest- und Notizbuchdateien.

Das Anwendungspaket und die Live-Version

Das Anwendungspaket oder App-Paket ist ein Container für alle Dateien, aus denen die App besteht, darunter die Manifest-Datei und beliebige Snowflake-Notizbücher. Wenn Sie ein Anwendungspaket erstellen, wird auch eine Live-Version (im Stagingbereich) des Anwendungspakets erstellt. Die Live-Version ist ein Arbeitsbereich für die Entwicklung, in dem Sie Dateien hinzufügen oder aktualisieren können, wie z. B. die Manifest-Datei und die Notizbuchdateien. Darüber hinaus können Sie eine Vorschau anzeigen und die Umgebung vor der Veröffentlichung testen.

Sobald Sie mit der Live-Version der App zufrieden sind, können Sie die Live-Version übertragen, um eine neue unveränderliche Version des Anwendungspakets zu erstellen, die Sie dann veröffentlichen können.

Die Verwendung der Live-Version für die Entwicklung vereinfacht die Versionsverwaltung, indem nur eine einzige unveränderliche Version des Anwendungspakets, das zur Veröffentlichung bereit ist, und eine einzige Live-Version für die Entwicklung verwaltet werden. Das Snowflake Native App Framework verwaltet automatisch die Versionierung des Anwendungspakets, sodass Sie die Versionsnummern nicht manuell verfolgen müssen.

Das Snowflake Native App Framework verwaltet automatisch eine Live-Version für jedes Anwendungspaket. Auch wenn Sie die Live-Version entfernen, wird automatisch eine neue Live-Version aus der letzten bestätigten Version des Anwendungspakets erstellt.

Anwendungspaket erstellen

Anbietende entwickeln und testen ein Anwendungspaket (App-Paket). Ein Anwendungspaket enthält Dateien, die für die Freigabe der Daten in der App erforderlich sind, und definiert, wie Verbrauchende auf die Daten zugreifen können.

Dieser Prozess umfasst die folgenden Schritte:

  1. Anwendungspaketdatei erstellen (nur beim ersten Mal): Erstellt ein Anwendungspaket-Projekt, das später veröffentlicht wird. Dadurch wird auch die Live-Version des Anwendungspakets erstellt.

  2. Inhalt zum Anwendungspaket hinzufügen:

    1. Manifest-Datei erstellen oder aktualisieren: Diese Datei beschreibt das Anwendungspaket und dessen Inhalt.

    2. ** Notizbuchdateien herunterladen**. Wenn Notizbücher enthalten sein sollen, laden Sie eine Kopie herunter, die Sie in das Anwendungspaket aufnehmen.

    3. Dateien zur Live-Version des Anwendungspakets hinzufügen.

  3. Anwendungspaket erstellen: Ermöglicht es Ihnen, zu verifizieren , ob die Manifest-Datei gültig ist und ob alle Links in der Manifest-Datei korrekt sind.

  4. Anwendung testen. Installieren Sie die App, und probieren Sie sie aus. Nehmen Sie Änderungen vor, und erstellen Sie neu.

  5. Anwendungspaket committen: Erstellt eine neue unveränderliche Version der App, die veröffentlicht werden kann.

  6. Anwendungspaket veröffentlichen. Mit einem freigegebenen Paket können Sie ein neues Freigabeangebot erstellen, entweder privat oder öffentlich auf Snowflake Marketplace.

Dieser Prozess ist unter Tutorial: Erste Schritte mit Declarative Native Apps beschrieben. Dieser Abschnitt enthält zusätzliche Details zu den Optionen, die in den verschiedenen Phasen der Entwicklung verfügbar sind.

Das Diagramm zeigt die Schritte zur Erstellung eines Anwendungspakets: Fügen Sie Live-Paket, Build, Commit und Release hinzu. Das Diagramm zeigt auch die optionalen Schritte, die Sie überspringen können, um eine Live-Version auf einmal zu erstellen, zu committen und zu veröffentlichen.

Neues Anwendungspaket erstellen

Erstellen Sie zuerst ein neues Declarative Native App-Paket für die Dateien der App, entweder über Snowsight- oder über SQL-Befehle in Snowflake CLI und unter Verwendung des URL-Schemas snow://package/<DECL_SHARE_APP_PKG>/versions/LIVE/.

So erstellen Sie mit Snowsight ein neues Anwendungspaket:

  1. Melden Sie sich bei Snowsight an.

  2. Wählen Sie im Navigationsmenü die Option Projects » App Packages aus.

  3. Wählen Sie auf der Share Data + Code-Kontokarte die Option Create.

  4. Geben Sie einen Namen für Ihr Anwendungspaket ein, und wählen Sie dann Create.

Das neue leere Anwendungspaket wird erstellt. Dadurch wird auch eine Live-Version des Anwendungspakets erstellt, die Sie bearbeiten können.

Inhalte für das Anwendungspaket zusammenstellen

Ein Anwendungspaket enthält die folgenden Komponenten:

  • Eine Manifest-Datei (erforderlich): eine textbasierte Datei, die die Struktur der App definiert.

  • Snowflake Notebook-Dateien (optional): eine oder mehrere textbasierte Dateien, die als Frontend für die Benutzererfahrung dienen können und auf die freigegebenen Ansichten und Tabellen verweisen. Sie können auch Code, Referenzvisualisierungen und Logik enthalten, um die Darstellung der Daten zu unterstützen.

Diagramm der Komponenten des App-Pakets

Manifest-Datei erstellen oder aktualisieren

Sie können eine Manifest-Datei erstellen oder aktualisieren, die das Anwendungspaket und dessen freigegebene Inhalte beschreibt, z. B. Notizbücher, Tabellen und Ansichten. Sie definiert andere Metadaten, wie z. B. App-Rollen, die in der App enthalten sind.

Die Manifest-Datei muss den Namen manifest.yml tragen und muss der Stammebene des Anwendungspakets hinzugefügt werden.

Weitere Informationen dazu finden Sie unter Referenz zum Declarative Native App-Manifest. Das zugehörige Tutorial: Erste Schritte mit Declarative Native Apps enthält eine Beispiel-Manifest-Datei.

Erstellen oder Aktualisieren einer Manifestdatei aus einer Snowflake-Datenfreigabe

Bemerkung

Der folgende Inhalt wird von Snowflake nicht unterstützt. Der gesamte Code wird „AS IS“ und ohne Garantie zur Verfügung gestellt.

Wenn Sie über eine bestehende Datenfreigabe in Snowflake verfügen, können Sie automatisch eine Manifest-Datei mit dem Open-Source-Tool „Manifest from Share“ erstellen. Dieses von Snowflake bereitgestellte Tool generiert eine Manifest-Datei auf der Grundlage der Objekte in einer angegebenen Freigabe. Das Tool enthält auch Optionen, um die generierte Manifest-Datei anzupassen. Sie können dieses Tool auf folgende Weise verwenden:

  • Generieren Sie eine Manifest-Datei mit der Befehlszeilenschnittstelle (CLI).

  • Integrieren Sie das Tool als Bibliothek in einen bestehenden Python-Automatisierungs-Workflow.

Weitere Informationen zum Herunterladen und Verwenden des Tools finden Sie unter `Snowflake-Manifest von Freigabe<https://github.com/snowflakedb/native-apps-examples/tree/main/snowflake-manifest-from-share-library>`_-Repository auf GitHub.

Bemerkung

Das Tool „Manifest from Share“ erstellt nur die Manifest-Datei unter Verwendung der Datenbanken, Schemas, Tabellen und Ansichten der Datenfreigabe. Das Tool fügt keine anderen Objekte in die generierte Manifest-Datei ein.

Notizbuchdateien abrufen

Wenn Snowflake-Notizbücher in die App aufgenommen werden sollen, laden Sie eine Kopie der einzelnen Notizbuchdateien herunter, damit Sie sie in das Anwendungspaket aufnehmen können.

Über Snowsight:

  1. Wählen Sie im Navigationsmenü die Option Projects » Notebooks aus, und wählen Sie dann das Notizbuch aus, das Sie herunterladen möchten.

  2. Wählen Sie im linken Bereich neben Ihrem Notizbuch die Option … » Download aus.

Die Datei wird auf Ihren lokalen Computer als Datei mit dem Namen <notebook_name>.ipynb heruntergeladen.

Bemerkung

Die Notizbuch-Umgebung verfügt über eine Reihe vorinstallierter Anaconda-Pakete, darunter Python und Streamlit. Wenn Ihr Notizbuch zusätzliche Anaconda-Pakete verwendet, müssen Sie diese als Pakete zu Ihrem Notizbuch hinzufügen, damit sie in der Umgebung des Verbrauchenden verwendet werden können. Informationen darüber, wie Sie Anaconda-Pakete zu Ihrem Notizbuch hinzufügen, finden Sie unter Anaconda-Pakete zu einem Notizbuch hinzufügen.

Dateien zur Live-Version hinzufügen

Manifest- und Notizbuch-Dateien zur Live-Version des Anwendungspakets hinzufügen.

So füllen Sie mithilfe von Snowsight das Anwendungspaket auf:

  1. Wenn Sie die Auflistung des Anwendungspakets noch nicht anzeigen, wählen Sie im Navigationsmenü Projects » App Packages und dann das Anwendungspaket aus, dem Sie Dateien hinzufügen möchten.

  2. Wählen Sie Upload files aus. (Wenn Sie Dateien ersetzen oder zusätzliche Dateien hinzufügen, wählen Sie Manage files und dann Upload files aus.)

  3. Ziehen Sie die Notizbuch-Dateien und das Manifest von Ihrer Festplatte in das Dialogfeld Upload files, falls angegeben, oder wählen Sie Browse, um die Dateien zu suchen und auszuwählen.

  4. Wählen Sie Upload aus, um die Dateien in den Live-Stagingbereich hochzuladen und einen Build auszulösen.

Eine Datei aus dem Anwendungspaket herunterladen

Sie können eine Datei aus dem Anwendungspaket mit dem GET SQL-Befehl in Snowflake CLI herunterladen:

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

Inhalte aus dem Anwendungspaket entfernen

Sie können Dateien aus dem Anwendungspaket entfernen.

Verwenden von Snowsight:

  1. Wenn Sie die Auflistung des Anwendungspakets noch nicht anzeigen, wählen Sie im Navigationsmenü Projects » App Packages und dann das Anwendungspaket aus, aus dem Sie Dateien entfernen möchten.

  2. Wählen Sie Manage files » Remove files aus.

  3. Wählen Sie die Datei(en) aus, die Sie entfernen möchten, und wählen Sie dann Delete.

  4. Wählen Sie im Dialogfeld Remove files die zu entfernenden Dateien aus, und wählen Sie dann Remove & build aus.

Anwendungspaket erstellen

Als Nächstes erstellen Sie eine testbare Version der App.

In Snowsight:

  • Wenn Sie einen vollständigen Satz von Dateien in das Anwendungspaket hochladen, wird automatisch ein Build gestartet.

  • Um einen Build zu einem anderen Zeitpunkt auszuführen, wählen Sie die Schaltfläche „Build“ auf der Seite des Anwendungspakets aus.

Wenn die Manifest-Datei einen Fehler enthält, schlägt der Build fehl und stellt Informationen bereit, wie Sie den Fehler beheben können. Korrigieren Sie die Fehler und erstellen Sie das Anwendungspaket neu.

Die erstellte Anwendung bleibt im Live-Status, und Sie können weiterhin Änderungen am Anwendungspaket vornehmen.

Überspringen Sie!

Für Aktualisierungen, die keine weiteren Tests erfordern, können Sie überspringen, indem Sie ein Anwendungspaket auf einmal mit dem Befehl ALTER APPLICATION PACKAGE … RELEASE LIVE VERSION erstellen, committen und freigeben.

ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> RELEASE LIVE VERSION;
Copy

Anwendung testen

Nach dem Erstellen des Anwendungspakets können Sie grundlegende Tests daran in der Live-Umgebung durchführen.

Installieren Sie die App aus einem Anwendungspaket mit dem Befehl: CREATE APPLICATION … FROM APPLICATION PACKAGE, und ersetzen Sie dabei <DECL_SHARE_APP> mit dem Namen der App. Beispiel:

CREATE APPLICATION <DECL_SHARE_APP> FROM APPLICATION PACKAGE <DECL_SHARE_APP_PKG>
Copy

Aktualisieren Sie die Dateien im Anwendungspaket nach Bedarf, und prüfen Sie dann mit dem Befehl ALTER APPLICATION PACKAGE … UPGRADE USING VERSION LIVE, ob es funktioniert hat.

ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> UPGRADE USING VERSION LIVE;
Copy

Um einige Features zu testen, wie z. B. App-Rollen, müssen Sie zunächst eine neue Version des Anwendungspakets veröffentlichen und dann mit einem separaten Konto des Verbrauchenden testen. Weitere Informationen dazu finden Sie unter Declarative Native App installieren und Zugriff auf Inhalte in einer Declarative Native App.

Optional: Änderungen an einer Live-Version zurücksetzen

Wenn die an der Live-Version des Anwendungspakets vorgenommenen Änderungen nicht mehr benötigt werden, können Sie das Anwendungspaket mit dem Befehl ALTER APPLICATION PACKAGE … ABORT LIVE VERSION auf den Status vor den Änderungen zurücksetzen.

ALTER APPLICATION PACKAGE <DECL_SHARE_APP_PKG> ABORT LIVE VERSION;
Copy

Wenn Sie den obigen Befehl verwenden, um die aktuelle Live-Version zu entfernen, wird eine neue Live-Version mit demselben Inhalt wie die zuletzt übertragene Version des Anwendungspakets erstellt. Die Live-Version wird auf die letzte bestätigte Version zurückgesetzt , und alle an der Live-Version vorgenommenen Änderungen werden verworfen.

Anwendungspaket committen und freigegeben

Durch das Commit des Anwendungspakets wird eine neue unveränderliche Version der App erstellt, die nicht bearbeitet werden kann und bereit ist, veröffentlicht zu werden. Das Veröffentlichen des Anwendungspakets bewirkt Folgendes:

  • Stellt eine bestätigte App bereit, mit Verbrauchenden geteilt zu werden.

  • Wenn der Anbietende die App bereits für Verbrauchende freigegeben hat, steht diesen Verbrauchenden automatisch die neue Version zur Verfügung.

  • Wenn es bereits eine Live-Version der App in Snowflake Marketplace gibt, ist die neue Version automatisch für Verbrauchende verfügbar, die die App installiert haben.

So übertragen Sie mit Snowsight das Anwendungspaket und geben es frei:

  1. Wenn Sie die Auflistung des Anwendungspakets noch nicht anzeigen, wählen Sie im Navigationsmenü Projects » App Packages und dann das Anwendungspaket aus, das Sie freigeben möchten.

  2. Wählen Sie Commit & release aus.

  3. Wählen Sie im Bestätigungsdialog Acknowledge & continue aus.

Das bestätigte Anwendungspaket wird freigegeben und die Live-Version des Anwendungspakets wird entfernt. Aus der neuen bestätigten Version wird eine neue Live-Version des Anwendungspakets für die weitere Entwicklung erstellt.

Sobald Sie für das Anwendungspaket ein Commit ausgeführt und freigegeben haben, wird auf der Registerkarte Latest release der Inhalt des Releases angezeigt, der mit dem Inhalt des letzten Builds übereinstimmt.

Nachdem Sie das Anwendungspaket veröffentlicht haben, können Sie ein neues Freigabeangebot für die App erstellen, entweder privat oder öffentlich im Snowflake Marketplace. Weitere Informationen dazu finden Sie unter Freigabeangebot mit deklarativer Freigabe erstellen.