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__)) を使って、ローカルにバンドルされた path のベース directory を参照できます。これにより、ZIP アーカイブ内で main.py が配置されている directory の絶対 path が返され、バンドルされたほかのファイルにアクセスできるようになります。

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. この例では、デフォルト設定を使用します。設定パラメーターの一覧については、Executable user-defined functions を参照してください。
7. ファイルを参照 をクリックして、このチュートリアルの冒頭で作成した .zip ファイルをアップロードします。
8. 新しい引数を追加します。この例では、型 DateTime の引数 timestamp を追加します。
9. 戻り値の型を選択します。この例では Bool を選択します。
10. UDF を作成 をクリックします。現在のビルドステータスを示すダイアログが表示されます。
    • 問題がある場合、ステータスは error に変わります。
    • 問題がなければ、ステータスは building から provisioning に進みます。プロビジョニングを完了するには、サービスが稼働中である必要があります。サービスがアイドル状態の場合は、サービス名の横にある UDF details パネルで Wake Up Service をクリックします。
    • 完了すると、ステータスは deployed に変わります。

1. ページ左上の Settings - return to your service view をクリックして、SQL Console のホーム画面に戻ります
2. 左側のメニューで SQL Console をクリックします
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. メニューから User-defined functions を選択します。
3. isBusinessHours UDF の Actions にある 3 点メニューを選択し、Create new version をクリックします
4. 変更したコードを含む zip をアップロードするか、設定を変更してから Create new version をクリックします

これで、UI から最初のユーザー定義関数を追加し、それが実行されることを確認し、必要に応じて新しいバージョンを作成する方法も確認できました。