UDFs 用户自定义函数
可执行用户自定义函数
此功能在 ClickHouse Cloud 的私有预览中支持。请联系 ClickHouse 支持以获取访问权限,网址为 https://clickhouse.cloud/support。
ClickHouse 可以调用任何外部可执行程序或脚本来处理数据。
可执行用户自定义函数的配置可以位于一个或多个 XML 文件中。配置的路径在 user_defined_executable_functions_config 参数中指定。
函数配置包含以下设置:
name
- 函数名称。command
- 要执行的脚本名称或如果execute_direct
为 false 则为命令。argument
- 带有type
的参数描述,以及可选的参数名称。每个参数在单独的设置中描述。如果参数名称是用户自定义函数格式序列化的一部分,例如 Native 或 JSONEachRow,则需要指定名称。默认参数名称值为c
+ argument_number。format
- 传递给命令的参数的 格式。return_type
- 返回值的类型。return_name
- 返回值的名称。如果返回名称是用户自定义函数格式序列化的一部分,例如 Native 或 JSONEachRow,则需要指定返回名称。可选。默认值为result
。type
- 可执行类型。如果type
设置为executable
,则启动单个命令。如果设置为executable_pool
,则创建命令池。max_command_execution_time
- 处理数据块的最大执行时间(秒)。此设置仅适用于executable_pool
命令。可选。默认值为10
。command_termination_timeout
- 命令关闭管道后应完成的时间(秒)。超过该时间会向执行命令的进程发送SIGTERM
。可选。默认值为10
。command_read_timeout
- 从命令标准输出读取数据的超时时间(毫秒)。默认值 10000。可选参数。command_write_timeout
- 向命令标准输入写入数据的超时时间(毫秒)。默认值 10000。可选参数。pool_size
- 命令池的大小。可选。默认值为16
。send_chunk_header
- 控制是否在发送数据块进行处理之前发送行计数。可选。默认值为false
。execute_direct
- 如果execute_direct
=1
,则将在 user_scripts_path 指定的 user_scripts 文件夹中搜索command
。可以使用空格分隔符指定附加脚本参数。例如:script_name arg1 arg2
。如果execute_direct
=0
,则将command
作为参数传递给bin/sh -c
。默认值为1
。可选参数。lifetime
- 函数的重新加载间隔(秒)。如果设置为0
,则不重新加载该函数。默认值为0
。可选参数。deterministic
- 如果函数是确定性的(对于相同的输入返回相同的结果)。默认值为false
。可选参数。
命令必须从 STDIN
读取参数,并将结果输出到 STDOUT
。命令必须以迭代方式处理参数。也就是说,在处理一块参数后,它必须等待下一块。
示例
内联脚本
创建 test_function_sum
,手动指定 execute_direct
为 0
,使用 XML 配置。
文件 test_function.xml
(/etc/clickhouse-server/test_function.xml
,使用默认路径设置)。
查询:
结果:
Python 脚本
从 STDIN
读取一个值并将其作为字符串返回:
使用 XML 配置创建 test_function
。
文件 test_function.xml
(/etc/clickhouse-server/test_function.xml
,使用默认路径设置)。
脚本文件位于 user_scripts
文件夹中的 test_function.py
(/var/lib/clickhouse/user_scripts/test_function.py
,使用默认路径设置)。
查询:
结果:
从 STDIN
读取两个值并将它们的和作为 JSON 对象返回:
使用 XML 配置创建带命名参数和格式为 JSONEachRow 的 test_function_sum_json
。
文件 test_function.xml
(/etc/clickhouse-server/test_function.xml
,使用默认路径设置)。
脚本文件位于 user_scripts
文件夹中的 test_function_sum_json.py
(/var/lib/clickhouse/user_scripts/test_function_sum_json.py
,使用默认路径设置)。
查询:
结果:
在 command
设置中使用参数:
可执行用户自定义函数可以接受在 command
设置中配置的常量参数(仅适用于 executable
类型的用户自定义函数)。这也需要 execute_direct
选项(以确保没有外壳参数扩展漏洞)。
文件 test_function_parameter_python.xml
(/etc/clickhouse-server/test_function_parameter_python.xml
,使用默认路径设置)。
脚本文件位于 user_scripts
文件夹中的 test_function_parameter_python.py
(/var/lib/clickhouse/user_scripts/test_function_parameter_python.py
,使用默认路径设置)。
查询:
结果:
Shell 脚本
将每个值乘以 2 的 Shell 脚本:
可执行用户自定义函数可以与 Shell 脚本一起使用。
文件 test_function_shell.xml
(/etc/clickhouse-server/test_function_shell.xml
,使用默认路径设置)。
脚本文件位于 user_scripts
文件夹中的 test_shell.sh
(/var/lib/clickhouse/user_scripts/test_shell.sh
,使用默认路径设置)。
查询:
结果:
错误处理
某些函数在数据无效时可能会抛出异常。在这种情况下,查询会被取消,并将错误文本返回给客户端。对于分布式处理,当一个服务器发生异常时,其他服务器也会尝试中止查询。
参数表达式的评估
在几乎所有编程语言中,某些运算符可能不会评估一个参数。这通常是运算符 &&
、||
和 ?:
。但在 ClickHouse 中,函数(运算符)的参数始终被评估。这是因为整列会一次性被评估,而不是逐行计算。
对分布式查询处理执行函数
对于分布式查询处理,尽可能多的查询处理阶段在远程服务器上执行,其余阶段(合并中间结果及之后的所有阶段)在请求服务器上执行。
这意味着可以在不同的服务器上执行函数。
例如,在查询 SELECT f(sum(g(x))) FROM distributed_table GROUP BY h(y),
- 如果
distributed_table
至少有两个分片,则在远程服务器上执行函数 'g' 和 'h',而在请求服务器上执行函数 'f'。 - 如果
distributed_table
只有一个分片,则在该分片的服务器上执行所有 'f'、'g' 和 'h' 函数。
函数的结果通常不依赖于它在哪个服务器上执行。然而,有时这很重要。
例如,使用字典的函数使用运行时所在服务器的字典。
另一个例子是 hostName
函数,它返回其运行的服务器的名称,以便在 SELECT
查询中按服务器进行 GROUP BY
。
如果在请求服务器上执行查询中的一个函数,但您需要在远程服务器上执行它,可以将其包装在 'any' 聚合函数中或将其添加到 GROUP BY
的键中。
SQL 用户自定义函数
可以使用 CREATE FUNCTION 语句从 lambda 表达式创建自定义函数。要删除这些函数,请使用 DROP FUNCTION 语句。