创建 Python UDFs¶

编写 Python 模块和函数¶

编写遵循以下规范的模块：

• 定义模块。模块是包含 Python 定义和语句的文件。

• 在模块内定义函数。

• 如果函数接受实参，则每个实参必须属于 :ref:` SQL-Python 类型映射表 <label-sql_python_data_type_mappings>` 的 Python Data Type 列中指定的数据类型。

  函数实参受位置（而不是名称）约束。传递给 UDF 的第一个实参是 Python 函数接收的第一个实参。

• 指定适当的返回值。由于 Python UDF 必须是标量函数，因此每次调用时它都必须返回一个值。返回值的类型必须属于 :ref:` SQL-Python 类型映射表 <label-sql_python_data_type_mappings>` 的 Python Data Type 列中指定的数据类型。返回值的类型必须与 CREATE FUNCTION 语句的 RETURNS 子句中指定的 SQL 数据类型相兼容。

• 模块可以包含多个函数。Snowflake 调用的函数可以调用同一模块或其他模块中的其他函数。

• 您的函数（以及您的函数调用的任何函数）必须符合 Snowflake 对 Python UDFs 施加的约束。

创建内联 Python UDF¶

对于内联 UDF，您可以将 Python 源代码作为 CREATE FUNCTION 语句的一部分提供。

例如，以下语句创建一个内联 Python UDF，为给定整数加一：

create or replace function addone(i int)
returns int
language python
runtime_version = '3.8'
handler = 'addone_py'
as
$$
def addone_py(i):
  return i+1
$$;

Python 源代码在 AS 子句中指定。源代码可以放在单引号内，也可以放在一对美元符号 ($$) 内。如果源代码包含嵌入的单引号，则使用双美元符号通常更容易。

调用 UDF：

select addone(10);

以下是输出：

+------------+
| ADDONE(10) |
|------------|
|         11 |
+------------+

Python 源代码可以包含多个模块和一个模块中的多个函数，因此 HANDLER 子句指定要调用的模块和函数。

内联 Python UDF 可以调用 IMPORTS 子句所含模块中的代码。

有关 CREATE FUNCTION 语句的语法的更多信息，请参阅 CREATE FUNCTION。

有关更多示例，请参阅 内联 Python UDF 示例。

使用从暂存区上传的代码创建 Python UDF¶

以下语句使用从 暂存区 上传的代码创建简单的 Python UDF。托管文件的暂存区必须可由 UDF 的 :emph:` 所有者 ` 读取。此外，ZIP 文件必须独立，并且不依赖要执行的任何其他安装脚本。

创建名为 sleepy.py 且包含源代码的 Python 文件：

def snore(n):   # return a series of n snores
    result = []
    for a in range(n):
        result.append("Zzz")
    return result

启动 SnowSQL（CLI 客户端） 并使用命令 PUT，将文件从本地文件系统复制到名为 @~ 的默认用户暂存区。（ PUT 命令无法通过 Snowflake GUI 执行。）

put
file:///Users/Me/sleepy.py
@~/
auto_compress = false
overwrite = true
;

如果删除或重命名文件，则您无法再调用 UDF.如果需要更新文件，请在无法调用 UDF 时更新它。如果旧文件仍位于暂存区，则 PUT 命令应包含子句 OVERWRITE=TRUE。

创建 UDF。处理程序指定模块和函数。

create or replace function dream(i int)
returns variant
language python
runtime_version = '3.8'
handler = 'sleepy.snore'
imports = ('@~/sleepy.py')

调用 UDF：

select dream(3);

+----------+
| DREAM(3) |
|----------|
| [        |
|   "Zzz", |
|   "Zzz", |
|   "Zzz"  |
| ]        |
+----------+

create or replace function multiple_import_files(s string)
returns string
language python
runtime_version=3.8
imports=('@python_udf_dep/bar/python_imports_a.zip', '@python_udf_dep/foo/python_imports_b.zip')
handler='compute'
as
$$
def compute(s):
  return s
$$;