Cloud 中的用户自定义函数

在本地新建一个 main.py 文件：

cat > main.py << 'EOF'
import sys
from datetime import datetime

for line in sys.stdin:
    ts = datetime.fromisoformat(line.strip())
    result = 1 if (0 <= ts.weekday() <= 4 and 9 <= ts.hour <= 17) else 0
    print(result)
    sys.stdout.flush()
EOF

如果你的 Python 脚本导入了第三方包，请在 requirements.txt 文件中列出这些依赖项，ClickHouse Cloud 会为你安装。你也可以选择直接将依赖项打包到 ZIP 中，但这样就必须同时包含适用于两种 CPU 架构的缓存包，因此使用 requirements.txt 更简单。例如：

requests>=2.28.0
numpy>=1.23.0

要包含依赖包以及其他本地文件 (例如 wheel 文件、配置文件或数据文件) ，请将它们放在与您的 main.py 和 requirements.txt 相同的目录中。创建 ZIP 归档时，请包含所有文件：

zip is_business_hours.zip main.py requirements.txt

你可以在 Python 代码中使用 os.path.dirname(os.path.abspath(__file__)) 引用本地打包路径的基目录。它会返回 ZIP 归档中 main.py 所在目录的绝对路径，以便你访问其他一并打包的文件：

import os

# Get the base directory of the bundled files
base_dir = os.path.dirname(os.path.abspath(__file__))
config_path = os.path.join(base_dir, 'config.json')

在你需要执行以下操作时，这会很有用：

• 访问随 UDF 一起打包的配置文件
• 为自定义依赖加载 wheel 包
• 引用其他脚本或数据文件

现在将该文件压缩为 ZIP 压缩包：

zip is_business_hours.zip main.py

1. 在 Cloud 控制台主页上，点击左下角菜单中的组织名称。
2. 从菜单中选择用户自定义函数。
3. 在用户自定义函数页面中，点击设置 UDF。屏幕右侧会打开一个配置面板。
4. 输入函数名称。本示例使用 isBusinessHours。
5. 选择函数类型，可选 Executable pool 或 Executable：
   • Executable pool：系统会维护一个持久进程池，并从池中取出进程来处理读取请求。
   • Executable：脚本会在每次查询时运行。
6. 本示例使用默认设置。有关完整的配置参数列表，请参见可执行用户自定义函数。
7. 点击浏览文件，上传在本教程开头创建的 .zip 文件。
8. 添加一个新参数。本示例中，添加一个类型为 DateTime 的参数 timestamp。
9. 选择返回类型。本示例中，选择 Bool。
10. 点击创建 UDF。此时会显示一个对话框，展示当前构建状态。
    • 如果出现任何问题，状态将变为错误。
    • 否则，状态会从构建中变为预配中。你的服务必须处于唤醒状态才能完成预配。如果服务处于空闲状态，请在服务名称旁的 UDF 详细信息 面板中点击唤醒服务。
    • 完成后，状态将变为已部署。

1. 点击页面左上角的 Settings - 返回到服务视图，返回 SQL 控制台主页
2. 点击左侧菜单中的 SQL 控制台
3. 输入以下查询：

SELECT isBusinessHours('2026-03-20 10:00:00'::DateTime), isBusinessHours('2026-03-20 23:00:00'::DateTime);

你应该会看到如下结果：

true    false

如需更改 UDF 的代码，请创建一个新版本。Edit 面板仅用于管理 UDF 分配给哪些服务；在此处上传文件不会替换已部署的代码。

1. 在 Cloud Console 首页，点击左下角菜单中的组织名称。
2. 在菜单中选择 用户自定义函数。
3. 在 isBusinessHours UDF 的 操作 一栏中点击三点图标，然后点击 创建新版本
4. 上传包含修改后代码的 ZIP 压缩包，或修改设置，然后点击 创建新版本

你已成功通过 UI 添加了第一个用户自定义函数，确认其可正常运行，并了解了在需要时如何创建新版本。