创建 Snowpark 项目定义¶

snowflake.yml 文件包含 Snowpark 项目的函数和存储过程声明。

备注

目前，Snowpark 项目定义文件必须命名为 snowflake.yml。

下面的代码段显示了 Snowpark 项目定义文件的示例：包含两个函数和两个存储过程。hello_function 功能使用 Snowpark 的外部功能。

definition_version: '2'

mixins:
  snowpark_shared:
    artifacts:
      - dest: my_snowpark_project
        src: app/
    stage: dev_deployment

entities:

  hello_function:
    type: function
    identifier:
      name: hello_function
    handler: functions.hello_function
    signature:
      - name: name
        type: string
    returns: string
    external_access_integrations:
      - my_external_access
    secrets:
        cred: my_cred_name
    meta:
      use_mixins:
        - snowpark_shared

  hello_procedure:
    type: procedure
    identifier:
      name: hello_procedure
    handler: procedures.hello_procedure
    signature:
      - name: name
        type: string
    returns: string
    meta:
      use_mixins:
        - snowpark_shared

  test_procedure:
    type: procedure
    identifier:
      name: test_procedure
    handler: procedures.test_procedure
    signature: ''
    returns: string
    meta:
      use_mixins:
        - snowpark_shared

小心

执行其他 snow snowpark 命令时，项目目录中的文件会被 Snowflake CLI Snowflake 处理，并且可以上传到 Snowflake。在将任何敏感信息放入项目目录中的文件中时应小心谨慎。

函数和存储过程对象属性¶

下表描述了函数和存储过程使用的属性。

函数和存储过程对象属性¶
属性	定义
identifier optional、string	实体的可选 Snowflake 标识符。该值可以采用以下形式：字符串标识符文本 identifier: my-snowpark-id 支持不带引号和带引号的标识符。要使用带引号的标识符，请在 YAML 值中包含周围的引号（例如 `’”My Snowpark Function”’`）。对象 identifier: name: my-snowpark-id schema: my-schema # optional database: my-db # optional 备注如果指定 `schema` 或 `database`，并在 `name` 属性中使用完全限定名称（例如 `mydb.schema1.my-app`），则会发生错误。
type optional、string	必须是以下之一：`function` 或 `procedure`。
artifact_repository optional、string	工件存储库的名称。Snowflake 有一个名为 `snowflake.snowpark.pypi_shared_repository` 的默认工件存储库，用于在 Snowpark UDFs 和过程中连接和安装 PyPI 包。有关更多信息，请参阅 Artifact Repository 概述。 `artifact_repository` 和 `packages` 参数允许您使用非 Anaconda 的包，类似于以下示例：在项目的 `app.py` 文件中，可以定义一个如下函数： from sklearn.datasets import load_iris from sklearn.model_selection import train_test_split from sklearn.ensemble import RandomForestClassifier def udf(): X, y = load_iris(return_X_y=True) X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.25, random_state=42) model = RandomForestClassifier() model.fit(X_train, y_train) return model.score(X_test, y_test) 在 `snowflake.yml` 文件中，可以定义一个如下函数： test_function: type: "function" handler: "app.udf" identifier: - name: "udf" stage: "dev_deployment" signature: "" returns: float artifact_repository: snowflake.snowpark.pypi_shared_repository packages: - "scikit-learn" artifacts: "app.py" 对于依赖于特定架构的包，您可以在 `resource_constraint` 参数中定义它们，如下所示： test_function: type: "function" handler: "app.udf" identifier: - name: "udf" stage: "dev_deployment" signature: "" returns: float artifact_repository: snowflake.snowpark.pypi_shared_repository packages: - "scikit-learn" artifacts: "app.py" 有关更多信息，请参阅仅为 x86 构建的包。
artifact_repository_packages optional、string	备注此属性已被弃用，取而代之的是 `packages` 属性。
packages optional、string	要从 artifact_repository 安装的包列表。例如： artifact_repository: snowflake.snowpark.pypi_shared_repository packages: - Faker - rich - pytest
artifacts required、string sequence	要添加到部署根的文件源和目标对的列表。您可以使用以下工件属性： `src`：一个或多个代码源文件的路径。 `dest`：要部署工件的目录的路径。引用目录的目标路径必须以 `/` 结尾。如果 glob 模式的目标不是以 `/` 结尾，则会导致错误。如果省略，`dest` 默认为与 `src` 字符串相同。备注在 Snowpark `snowflake.yml` 文件中使用 glob 模式需要启用 ENABLE_SNOWPARK_GLOB_SUPPORT 功能标志。您还可以为每个项目传递一个字符串，而不是 `dict`，在这种情况下，该值将视为 `src` 和 `dest`。如果 `src` 仅引用一个文件（而不是 glob），`dest` 可以引用目标 `<path>` or a `<path/name>`。您还可以为每个项目传递一个字符串，而不是 `dict`，在这种情况下，该值将被视为 `src` 和 `dest`。
handler required、string	`snowpark.src` 中定义的模块内部对象的函数或存储过程的实施。例如，`functions.hello_function` 会引用文件 `<src>/functions.py` 中的函数 `hello_function`。
returns required、string	结果的 SQL 类型。检查可用类型列表。
signature required、sequence	`signature` 参数描述传递给对象的连续实参。每个实参都应指定其名称和类型，例如： signature: - name: "first_argument" type: int - name: "second_argument" default: "default value" type: string 如果函数或存储过程不取实参，请将此值设置为空字符串 (`signature: ""`)。检查可用类型 <label-sql_python_data_type_mappings>`的 SQL Type 列。要了解有关命名实参和可选实参的语法的更多信息，请参阅 :ref:`label-call_udf_calling_udf_optional。
runtime optional、string	Python version to use when executing the procedure or function. Default: "3.12".
external_access_integrations optional、string sequence	此过程的处理程序代码访问外部网络所需的外部访问集成的名称。有关更多详细信息，请参阅 CREATE PROCEDURE 中的EXTERNAL_ACCESS_INTEGRATIONS 参数。
secrets optional、dictionary	将密钥的名称分配给变量，以便在从处理程序代码中的密钥中检索信息时，可以使用这些变量引用密钥。有关更多详细信息，请参阅 CREATE PROCEDURE 中的 SECRETS 参数。
imports optional、string sequence	要导入的先前已上传文件的暂存区和路径。有关更多详细信息，请参阅 CREATE PROCEDURE 中的 IMPORT 参数。
execute_as_caller optional、bool	仅适用于存储过程。确定存储过程是以所有者（您）的权限还是以调用者的权限执行。默认值：False（所有者权限）。