用户定义函数 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。可选参数。
命令必须从 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 对象返回：
使用带命名参数和格式 JSONEachRow 的 XML 配置创建 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 选项（以确保没有 shell 参数扩展漏洞）。
文件 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 语句。