設定された Snowflake Native App アーティファクトを含むローカルフォルダーの準備¶

設定された成果物を含むローカル・フォルダーを作成する。¶

snow app bundle コマンドは、プロジェクトにローカルディレクトリを作成し、プロジェクト定義ファイルで指定したファイル構造をそのディレクトリに入れ、デコレーター（ @sproc や @udaf など）を含む Snowpark Python コードから、Snowflake Native App セットアップスクリプトに CREATE FUNCTION または CREATE PROCEDURE の宣言を生成します。詳細については、 snowflake.snowpark.functions.udaf など、選択した関数デコレーターに対応する Snowpark Python ドキュメントをご参照ください。

snow app deploy と:codenowrap:snow app run コマンドは、すでにこの機能を使用しています。しかし、明示的な:codenowrap:snow app bundle コマンドを自由に使えるようになったので、ステージにアップロードされる前にこのディレクトリを探索し、アーティファクトが期待通りに作成されたかを確認することができます。

設定された成果物を含むローカル・フォルダを作成するには、以下のようにします。

1. 次のようなSnowflake snowflake.yml プロジェクト定義ファイルを作成または検証します。

   definition_version: 2
   entities:
     codegen_nativeapp_pkg:
       type: application package
       manifest: root_files/_manifest.yml
       artifacts:
         - src: root_files/README.md
           dest: README.md
         - src: root_files/_manifest.yml
           dest: manifest.yml
         - src: root_files/setup_scripts/*
           dest: setup_scripts/
         - src: python/user_gen/echo.py
           dest: user_gen/echo.py
         - src: python/cli_gen/*
           dest: cli_gen/
           processors:
             - snowpark
     codegen_nativeapp_pkg:
       type: application
       from:
         target: codegen_nativeapp_pkg
   

   Copy

2. プロジェクト・ディレクトリから snow app bundle コマンドを実行し、設定した成果物を含む仮 output/deploy ディレクトリを作成します。

   snow app bundle
   

   Copy

3. 出力またはデプロイディレクトリの内容が、snowflake.yml.ファイルで指定したルールと一致していることを確認します。PythonファイルでSnowparkアノテーション処理を呼び出した場合、ディレクトリ内の修正されたセットアップスクリプトで生成されたコードを見ることができます。

詳細については、 snow app bundle コマンドをご参照ください。

Snowparkアノテーション処理を使用して SQL コードを生成します。¶

限定的な SQL の経歴を持つ Snowflake Native App 開発者であれば、時間の経過とともに非常に大きく複雑になる可能性がある セットアップスクリプト を書いたり保守したりするのは面倒だと感じるかもしれません。セットアップスクリプトには、カスタマーがデータで使用できるすべてのアプリケーションロジックが含まれているため、Snowflake Native Appの開発には必須です。セットアップスクリプトのコアコンポーネントの1つは、関数やストアドプロシージャにSnowpark Python拡張関数を使用できることです。Python、Java、またはその他のSnowparkがサポートする言語でSnowparkコードを記述することに加えて、セットアップスクリプトで SQL 、これらの関数やプロシージャの対応する部分を記述する必要があります。

例えば、Snowpark Pythonを使って、次のように基本的な関数とストアドプロシージャを作成することができます。

# Example python file "echo.py" that a developer writes

def echo_fn(data):
    return 'echo_fn: ' + data

def echo_proc(session, data):
    return 'echo_proc: ' + data

そのファイルをステージにアップロードし、セットアップスクリプト SQL 、次のようなコードで参照する必要があります。

-- Sample setup_script.sql SQL file for a Snowflake Native App

CREATE APPLICATION ROLE IF NOT EXISTS app_instance_role;

CREATE OR ALTER VERSIONED SCHEMA ext_code_schema;
GRANT USAGE ON SCHEMA ext_code_schema TO APPLICATION ROLE app_instance_role;

CREATE OR REPLACE PROCEDURE ext_code_schema.py_echo_proc(DATA string)
  RETURNS STRING
  LANGUAGE PYTHON
  RUNTIME_VERSION = 3.9
  PACKAGES=('snowflake-snowpark-python')
  HANDLER='echo.echo_proc'
  IMPORTS=('/echo.py');

    GRANT USAGE ON PROCEDURE ext_code_schema.py_echo_proc(string)
      TO APPLICATION ROLE app_instance_role;

-- Wraps a function from a python file
CREATE OR REPLACE FUNCTION ext_code_schema.py_echo_fn(string)
RETURNS STRING
LANGUAGE PYTHON
RUNTIME_VERSION = 3.9
PACKAGES=('snowflake-snowpark-python')
HANDLER='echo.echo_fn'
IMPORTS=('/echo.py');

GRANT USAGE ON FUNCTION ext_code_schema.py_echo_fn(DATA string)
  TO APPLICATION ROLE app_instance_role;

# some python file echo.py
@udf(name="echo_fn")
def echo_fn(data) -> str:
  return 'echo_fn: ' + str

-- Sample setup_script.sql SQL file for a Snowflake Native App

-- User-written code
CREATE OR REPLACE APPLICATION ROLE app_instance_role;

CREATE OR ALTER VERSIONED SCHEMA ext_code_schema;
GRANT USAGE ON SCHEMA ext_code_schema TO APPLICATION ROLE app_instance_role;

-- Snowflake CLI generated code
CREATE OR REPLACE FUNCTION ext_code_schema.py_echo_fn(DATA string)
  RETURNS STRING
  LANGUAGE PYTHON
  RUNTIME_VERSION = 3.9
  PACKAGES=('snowflake-snowpark-python')
  HANDLER='echo.echo_fn'
  IMPORTS=('/echo.py');

  GRANT USAGE ON FUNCTION ext_code_schema.py_echo_fn(string)
    TO APPLICATION ROLE app_instance_role;

Snowpark Python の使用を開始します。¶

Snowflake CLI の Snowpark デコレーターは、通常の Snowpark Python デコレーターと同じように動作しますが、 Snowflake Native App 用の Python コードファイルを書く際には、以下の違いに注意する必要があります。

• これらのファイルで:codenowrap:Session オブジェクトを使用することはできません。 Snowflake CLI は、Snowflake に接続しないサンドボックス環境でこれらの Python ファイルを実行するからです。その結果、Snowparkの:codenowrap:Session を参照するとエラーになります。

• @udf 、 @sproc、 @udaf、 @udtf Snowpark Python デコレーターのみを使用できます。

• これらのデコレーターを通常の関数として使用して、コードをSnowflakeオブジェクトとして登録することはできません。サポートされているデコレーターで明示的にアノテーションされたコードのみが認識されます。したがって、Pythonの関数は名前付き関数でなければなりません。Lambda関数はサポートされていません。

• Snowflake CLI はセットアップスクリプトでファンクションやプロシージャを作成するために、Snowflakeが推奨する ステートメントである CREATE OR REPLACE を常に生成します。

# output/deploy/dest_dir1/dest_dir2/echo.py
#: @sproc(
#:    return_type=IntegerType(),
#:    input_types=[IntegerType(), IntegerType()],
#:    packages=["snowflake-snowpark-python==1.15.0"],
#:    native_app_params={
#:        "schema": "ext_code_schema",
#:        "application_roles": ["app_instance_role"],
#:    },
#: )
def add_sp(session_, x, y):
    return x + y