네이티브 애플리케이션 프레임워크의 선언적 공유에서 사용되는 애플리케이션 패키지

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.

이 과정에는 다음 단계가 포함됩니다.

  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.

이 프로세스는 :doc:`tutorials/getting-started`에 설명되어 있습니다. 이 섹션에는 다양한 스테이징 단계에서 사용할 수 있는 옵션에 대한 추가 세부 정보가 포함되어 있습니다.

애플리케이션 패키지를 만드는 단계를 보여주는 다이어그램: 라이브 패키지를 추가하고, 빌드하고, 커밋하고, 릴리스합니다. 이 다이어그램은 라이브 버전을 한 번에 빌드, 커밋, 릴리스하기 위해 건너뛸 수 있는 선택적 단계도 보여줍니다.

새 애플리케이션 패키지 만들기

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.

앱 패키지 구성 요소 다이어그램

매니페스트 파일 만들기 또는 업데이트하기

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`에는 예제 매니페스트 파일이 포함되어 있습니다.

Create or update a manifest file from a Snowflake data share

참고

다음 내용은 Snowflake에서 지원되지 않습니다. 모든 코드는 “있는 그대로” 제공되며 보증되지 않습니다.

Snowflake에 기존 데이터 공유가 있는 경우 공유 도구의 오픈 소스 매니페스트를 사용하여 매니페스트 파일을 자동으로 생성할 수 있습니다. Snowflake에서 제공하는 이 도구는 지정된 공유의 오브젝트를 기준으로 매니페스트 파일을 생성합니다. 이 도구에는 생성된 매니페스트 파일을 사용자 지정하는 옵션도 포함되어 있습니다. 이 도구는 다음과 같은 방법으로 사용할 수 있습니다.

  • 명령줄 인터페이스(CLI)를 사용하여 매니페스트 파일을 생성합니다.

  • 이 도구를 기존 Python 자동화 워크플로에 라이브러리로 통합합니다.

이 도구를 다운로드하고 사용하는 방법에 대한 자세한 내용은 GitHub에서 `공유의 Snowflake 매니페스트<https://github.com/snowflakedb/native-apps-examples/tree/main/snowflake-manifest-from-share-library>`_ 리포지토리를 참조하세요.

참고

공유 도구의 매니페스트는 데이터 공유의 데이터베이스, 스키마, 테이블 및 뷰를 사용하여 매니페스트 파일만 생성합니다. 이 도구는 생성된 매니페스트 파일에 다른 오브젝트를 포함하지 않습니다.

노트북 파일 가져오기

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.

|sf-web-interface|에서 다음을 수행합니다.

  1. 탐색 메뉴에서 Projects » :ui:`Notebooks`를 선택한 후 다운로드할 노트북을 선택합니다.

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

파일은 로컬 컴퓨터에 <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:

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.

애플리케이션 패키지 빌드하기

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.

빌드된 앱은 라이브 상태로 유지되며 애플리케이션 패키지를 계속 변경할 수 있습니다.

건너뛰기!

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

애플리케이션 테스트하기

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 Declarative Native App 설치하기 and |declarative-app-short|의 콘텐츠에 액세스하기.

선택 사항: 라이브 버전에서 편집 재설정하기

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:

  • 커밋된 앱을 컨슈머와 공유하도록 준비합니다.

  • 공급자가 이미 앱을 컨슈머와 공유한 경우 해당 컨슈머는 새 버전을 자동으로 사용할 수 있습니다.

  • 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 선언적 공유를 사용하여 목록 만들기.