为本地文件夹准备已配置的 Snowflake Native App 工件¶

创建一个本地文件夹，其中包含已配置的工件¶

snow app bundle 命令会在您的项目中创建一个本地目录，使用您在项目定义文件中指定的文件结构填充该目录，并从包含装饰器（如 @sproc 或 @udaf）的 Snowpark Python 代码在 Snowflake Native App 安装脚本中生成 CREATE FUNCTION 或 CREATE PROCEDURE 声明。有关更多信息，请参阅与所选函数装饰器相对应的 Snowpark Python 文档，如 snowflake.snowpark.functions.udaf。

snow app deploy 和 snow app run 命令已经使用了这一功能。不过，现在有了明确的 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 代码¶

作为 Snowflake Native App 开发人员，如果您的 SQL 背景有限，您可能会发现编写和维护 安装脚本 非常麻烦，随着时间的推移，脚本可能会变得相当庞大和复杂。安装脚本包含客户可使用其数据应用程序的所有应用逻辑，因此是开发 Snowflake Native App 的必要组成部分。安装脚本的核心组件之一是您可以将 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 代码文件时，您应该注意以下区别：

• 您无法在这些文件中使用任何 Session 对象，因为 Snowflake CLI 是在与 Snowflake 无关的沙盒环境中执行这些 Python 文件的。因此，任何对 Snowpark 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