Snowflake Native App マニフェスト参照¶

manifest_version: 1¶

このバージョンのマニフェストファイルは、 Snowflake Native Apps の現在およびレガシーの機能をサポートしています。

例: manifest_version: 1

manifest_version: 2¶

このバージョンのマニフェストファイルは、権限の自動付与を含む追加機能をサポートしています。

例: manifest_version: 2

manifest_version の例¶

manifest_version: 2

name¶

スキーマの名前を指定します。

このフィールドはオプションです。

例: name: v1

patch¶

デフォルトのパッチ番号を指定します。

このフィールドはオプションです。

例: patch: 1

label¶

コンシューマーに表示されるバージョンの名前を指定します。

このフィールドはオプションです。

例: label: "Initial Release"

comment¶

バージョンのコメントを指定します。このコメントは、 Snowsight に表示されます。または、プロバイダーが SHOW VERSIONS IN APPLICATION PACKAGE コマンドを実行した場合に表示されます。

このフィールドはオプションです。

例: comment: "This is the initial release of the app."

version: の例¶

version:
  name: v1
  patch: 1
  label: "Initial Release"
  comment: "This is the initial release of the app."

setup_script:¶

Snowflake Native App のインストール時またはアップグレード時に実行されるセットアップスクリプトのパスとファイル名を指定します。値を指定しない場合、アプリはマニフェストファイルと同じディレクトリにあるデフォルト値 setup.sql を使用します。

例: setup_script: scripts/setup.sh

readme:¶

アプリとその機能の概要を提供するMarkdownのReadmeファイルへのパスを指定します。

Streamlitアプリの場合は、 default_streamlit プロパティに値が指定されないと、インストールされた Snowflake Native App を表示する際に、このファイルのコンテンツがコンシューマーに表示されます。

このファイルの場所は、マニフェストファイルの場所から相対的に指定されます。

このフィールドはオプションですが、SnowflakeではアプリにReadmeファイルを含めることを推奨しています。

例: readme: docs/README.md

default_streamlit_app:¶

Snowflake Native App にStreamlitアプリが含まれている場合、このプロパティは、コンシューマーが利用可能なデフォルトのStreamlitアプリのスキーマと名前を指定します。

アプリにStreamlitアプリが含まれている場合、このフィールドは必須です。

extension_code:¶

Java、Python、Scalaなどの拡張コード言語の使用を有効または無効にします。

例: extension_code: true

container_services:¶

コンテナを使用するアプリで使用されるコンテナイメージの場所を指定します。詳細については、 コンテナを使用したアプリで使用されるコンテナイメージを指定する をご参照ください。

コンテナ付きアプリでは、このフィールドは必要です。

images:
- /spcs_app/napp/img_repo/eap_frontend
- /spcs_app/napp/img_repo/eap_backend
- /spcs_app/napp/img_repo/eap_router

artifacts の例¶

artifacts:
  setup_script: scripts/setup.sql
  readme: docs/README.md
  default_streamlit_app: apps/main.py
  extension_code: true
  container_services:
      uses_gpu: true
      images:
        - /spcs_app/napp/img_repo/eap_frontend
        - /spcs_app/napp/img_repo/eap_backend

log_level:¶

アプリ Snowflake Native App で使用するログレベルを指定します。

このプロパティに値を設定しないと、デフォルトのログデータはキャプチャされません。

サポートされる値については、 ロギング、メトリクス、トレースのレベル設定 をご参照ください。

trace_level:¶

アプリで使用するトレースイベントレベルを指定します。プロバイダーがトレースを有効にすると、アプリはすべてのクエリとストアドプロシージャ呼び出しの開始時刻と終了時刻を自動的にキャプチャします。

このプロパティに値を設定しないと、トレースイベントはキャプチャされません。

trace_level プロパティのサポートされている値については ロギング、メトリクス、トレースのレベル設定 をご参照ください。

metric_level:¶

アプリに使用するメトリック・レベルを指定します。プロバイダーがメトリクスを有効にすると、アプリは自動的に自動計測されたリソース・メトリクスのデータ・ポイントをイベント・テーブルに出力します。

詳細については、 アプリのログとトレースのレベルを設定する をご参照ください。

metric_level プロパティのサポートされている値については ロギング、メトリクス、トレースのレベル設定 をご参照ください。

grant_callback:¶

コンテナを持つアプリのコールバック関数のスキーマと名前を指定します。コールバック関数は、コンピューティングプールやサービスを作成し、アプリケーションに必要なその他のセットアップタスクを実行できるストアドプロシージャです。

コンテナ付きアプリでは、このフィールドは必要です。

詳細については、 grant_callback プロパティを使用してサービスを作成する をご参照ください。

例: grant_callback: my_schema.my_grant_callback

configuration の例¶

configuration:
  log_level: INFO
  trace_level: OFF
  metric_level: BASIC
  grant_callback: my_schema.my_grant_callback

<privilege_name>:¶

コンシューマーアカウントでアプリがリクエストする権限の名前を指定します。

privileges プロパティが指定されている場合、このフィールドは必須です。

privileges: の例¶

privileges:
- CREATE TABLE:
  description: 'Required to create tables in the consumer account.'
- CREATE COMPUTE POOL:
  description: 'Required to allow the app to create a compute pool in the consumer account.'
- BIND SERVICE ENDPOINT:
  description: 'Required to allow endpoints to be externally accessible.'

- <reference_name>:¶

コンシューマーアカウントでアプリがリクエストする参照の名前を指定します。

references プロパティが指定されている場合、このフィールドは必須です。

privileges:
  - SELECT
  - INSERT

references の例¶

references:
- ORDERS_TABLE:
    label: "Orders table"
    description: "Orders table in TPC-H samples"
    privileges:
      - SELECT
    object_type: VIEW
    multi_valued: false
    register_callback: v1.register_single_callback

- EXTERNAL_ENDPOINT_EAI:
    label: "Allows egress to an external API"
    description: "EAI for Egress from NA+SPCS"
    privileges: [USAGE]
    object_type: EXTERNAL_ACCESS_INTEGRATION
    register_callback: v1.register_single_callback
    configuration_callback: v1.get_configuration
    required_at_setup: true

enabled:¶

呼び出し元の権限が制限された実行可能ファイルの作成をアプリに許可するかどうかを指定します。

アプリが制限された呼び出し元権限で実行されるストアドプロシージャまたは Snowpark Container Services サービスを作成する場合、プロバイダーはこのプロパティを true に設定する必要があります。

description:¶

アプリが呼び出し元権限が制限された実行可能ファイルを作成する必要がある理由の説明を提供します。

restricted_callers_rights: の例¶

restricted_callers_rights:
  enabled: true
  description: "Required to create stored procedures that run with restricted caller's rights."