Python 用户自定义函数 (UDF)

chDB 支持将 Python 函数注册为可通过 SQL 调用的 UDF。这些函数以原生方式在进程内运行，无需创建子进程，也没有序列化开销。函数具备类型安全性，支持根据 Python 注解自动类型推断，并提供可配置的 NULL 和异常处理。

快速入门

from chdb import query, func
from chdb.sqltypes import INT64

@func([INT64, INT64], INT64)
def add(a, b):
    return a + b

result = query("SELECT add(2, 3)")
print(result)  # 5

注册方式

`@func` 装饰器

from chdb import func
from chdb.sqltypes import INT64, STRING

# Explicit types
@func([INT64, INT64], INT64)
def add(a, b):
    return a + b

# Types inferred from annotations
@func()
def multiply(a: int, b: int) -> int:
    return a * b

# Explicit return_type, arg_types inferred from annotations
@func(return_type=STRING)
def greet(name: str):
    return f"Hello, {name}!"

经过装饰的函数仍可像普通 Python 函数一样调用：

add(2, 3)       # 5 (Python call)
query("SELECT add(2, 3)")  # 5 (SQL call)

`create_function`

为任何可调用对象 (lambda、函数、method) 指定名称并注册：

from chdb import create_function, query
from chdb.sqltypes import INT64, STRING

create_function("strlen", len, arg_types=[STRING], return_type=INT64)
query("SELECT strlen('hello')")  # 5

create_function("double", lambda x: x * 2, arg_types=[INT64], return_type=INT64)
query("SELECT double(21)")  # 42

`drop_function`

移除已注册的 UDF。删除未注册的名称不会有任何影响，因此可以放心地无条件调用：

from chdb import drop_function

drop_function("strlen")
# query("SELECT strlen('hello')")  # Error: function not found

类型系统

可用类型

所有类型均可从 chdb.sqltypes 导入：

from chdb.sqltypes import (
    # Boolean
    BOOL,
    # Signed integers
    INT8, INT16, INT32, INT64, INT128, INT256,
    # Unsigned integers
    UINT8, UINT16, UINT32, UINT64, UINT128, UINT256,
    # Floating point
    FLOAT32, FLOAT64,
    # String
    STRING,
    # Date and time
    DATE, DATE32, DATETIME, DATETIME64,
)

指定类型

可通过以下四种方式指定类型：

方法	示例	描述
`ChdbType` 常量	`INT64`, `STRING`	从 `chdb.sqltypes` 导入
ClickHouse 类型字符串	`"Int64"`, `"String"`	标准 ClickHouse 类型名称
参数化字符串	`"DateTime('UTC')"`, `"DateTime64(6)"`	用于带参数的类型
Python 类型	`int`, `str`, `float`	直接传入 `arg_types`/`return_type`，或在函数签名中用作类型注解

from chdb import create_function, func
from chdb.sqltypes import INT64

# All equivalent:
create_function("f1", lambda x: x * 2, arg_types=[INT64], return_type=INT64)
create_function("f2", lambda x: x * 2, arg_types=["Int64"], return_type="Int64")
create_function("f3", lambda x: x * 2, arg_types=[int], return_type=int)

@func()
def f4(x: int) -> int:
    return x * 2

自动类型推断

省略 arg_types 或 return_type 时，chDB 会根据 Python 类型注解自动推断类型：

Python 类型	ClickHouse 类型
`bool`	`Bool`
`int`	`Int64`
`float`	`Float64`
`str`	`String`
`bytes`	`String`
`bytearray`	`String`
`datetime.date`	`Date`
`datetime.datetime`	`DateTime64(6)`

@func()
def process(name: str, age: int) -> str:
    return f"{name} is {age} years old"

# Equivalent to:
# @func([STRING, INT64], STRING)

始终必须指定返回类型：如果省略 return_type，且函数没有返回类型注解，则注册会失败。相比之下，参数类型是可选的——既未显式指定类型，也没有注解的参数，可动态接受任何受支持的输入类型。

NULL 处理

on_null 参数用于控制任一输入参数为 NULL 时的行为。

值	行为
`"skip"` (默认)	不调用函数，立即返回 NULL
`"pass"`	将 NULL 转换为 Python `None`，然后正常调用函数

也可以使用枚举：chdb.NullHandling.SKIP / chdb.NullHandling.PASS。

示例：default (跳过)

@func(return_type="Int64")
def increment(x: int) -> int:
    return x + 1

query("SELECT increment(NULL)")  # NULL
query("SELECT increment(5)")     # 6

示例：将 NULL 传递为 `None`

@func(return_type="Int64", on_null="pass")
def null_to_zero(x):
    return 0 if x is None else x + 1

query("SELECT null_to_zero(NULL)")  # 0
query("SELECT null_to_zero(5)")     # 6

示例：多个参数

@func(arg_types=["Int64", "Int64"], return_type="Int64", on_null="pass")
def add_or_zero(a, b):
    return (a or 0) + (b or 0)

query("SELECT add_or_zero(NULL, 5)")    # 5
query("SELECT add_or_zero(NULL, NULL)") # 0
query("SELECT add_or_zero(3, 7)")       # 10

异常处理

on_error 参数用于控制 Python 函数引发异常时的行为。

值	行为
`"propagate"` (默认)	将异常作为 SQL 错误抛出
`"ignore"`	捕获异常，并为该行返回 NULL

也可以使用枚举：chdb.ExceptionHandling.PROPAGATE / chdb.ExceptionHandling.IGNORE。

示例：default (向上传播)

@func(arg_types=["Int64", "Int64"], return_type="Int64")
def divide(a, b):
    return a // b

query("SELECT divide(10, 2)")  # 5
query("SELECT divide(1, 0)")   # Error: ZeroDivisionError

示例：忽略错误

@func(arg_types=["Int64", "Int64"], return_type="Int64", on_error="ignore")
def safe_divide(a, b):
    return a // b

query("SELECT safe_divide(10, 2)")  # 5
query("SELECT safe_divide(1, 0)")   # NULL

组合使用 NULL 和异常处理

on_null 和 on_error 选项可以组合使用：

on_null	on_error	NULL 输入	异常
`"skip"`	`"propagate"`	返回 NULL	抛出错误
`"skip"`	`"ignore"`	返回 NULL	返回 NULL
`"pass"`	`"propagate"`	以 `None` 作为参数调用	抛出错误
`"pass"`	`"ignore"`	以 `None` 作为参数调用	返回 NULL

@func(
    arg_types=["Int64", "Int64"],
    return_type="Int64",
    on_null="pass",
    on_error="ignore",
)
def robust_divide(a, b):
    if a is None or b is None:
        return -1
    return a // b

query("SELECT robust_divide(10, 2)")     # 5
query("SELECT robust_divide(NULL, 2)")   # -1
query("SELECT robust_divide(1, 0)")      # NULL (exception caught)

日期时间和时区支持

UDFs 完全支持具有时区信息的日期和时间类型。

Date 类型

from datetime import date, timedelta

@func()
def next_day(d: date) -> date:
    return d + timedelta(days=1)

@func()
def get_year(d: date) -> int:
    return d.year

query("SELECT next_day(toDate('2024-06-15'))")  # 2024-06-16
query("SELECT get_year(toDate('2024-06-15'))")  # 2024

带时区的 DateTime

from datetime import timedelta

@func(arg_types=["DateTime('UTC')"], return_type="DateTime('UTC')")
def add_one_hour(dt):
    return dt + timedelta(hours=1)

query("SELECT add_one_hour(toDateTime('2024-01-01 12:00:00', 'UTC'))")  # 2024-01-01 13:00:00

DateTime64 (高精度)

DATETIME64 的默认标度为 6 (微秒) ：

from datetime import timedelta

@func(arg_types=["DateTime64(6, 'UTC')"], return_type="DateTime64(6, 'UTC')")
def add_microsecond(dt):
    return dt + timedelta(microseconds=1)

query("SELECT add_microsecond(toDateTime64('2024-01-01 12:00:00.000000', 6, 'UTC'))")  # 2024-01-01 12:00:00.000001

在 session 中使用 UDF

UDF 会全局注册，同一进程中的所有 session 均可使用：

from chdb import session as chs, func
from chdb.sqltypes import INT64

@func([INT64], INT64)
def double(x):
    return x * 2

sess = chs.Session()
sess.query("CREATE TABLE t (x Int64) ENGINE = Memory")
sess.query("INSERT INTO t VALUES (1), (2), (3)")
result = sess.query("SELECT double(x) FROM t ORDER BY x", "CSV")
print(result)
# 2
# 4
# 6