system.user_defined_functions

説明

ユーザー定義関数 (UDF) の読み込みステータス、エラー情報、および設定メタデータを含みます。

カラム

• name (String) — UDF の名前。
• load_status (Enum8('Success' = 0, 'Failed' = 1)) — 読み込みステータス。設定可能な値:
  • Success — UDF は正常に読み込まれており、使用可能です
  • Failed — UDF の読み込みに失敗しました (詳細は 'loading_error_message' フィールドを参照してください) 。
• loading_error_message (String) — 読み込みに失敗した場合の詳細なエラーメッセージ。正常に読み込まれた場合は空です。
• last_successful_update_time (Nullable(DateTime)) — 最後に正常に更新された時刻のタイムスタンプ。一度も成功していない場合は NULL です。
• loading_duration_ms (UInt64) — UDF の読み込みにかかった時間 (ミリ秒) 。
• type (Enum8('executable' = 0, 'executable_pool' = 1)) — UDF のタイプ: 'executable' (単一プロセス) または 'executable_pool' (プロセスプール) 。
• command (String) — この UDF で実行するスクリプトまたはコマンド。
• format (String) — I/O に使用するデータフォーマット (例: 'TabSeparated'、'JSONEachRow') 。
• return_type (String) — 関数の戻り値の型 (例: 'String'、'UInt64') 。
• return_name (String) — 任意の戻り値識別子。設定されていない場合は空です。
• argument_types (Array(String)) — 引数の型の配列 (例: ['String', 'UInt64']) 。
• argument_names (Array(String)) — 引数名の配列。名前のない引数には空文字列が入ります。
• max_command_execution_time (UInt64) — データ block の処理に許可される最大秒数。'executable_pool' 型でのみ使用されます。
• command_termination_timeout (UInt64) — コマンドプロセスに SIGTERM を送信するまでの秒数。
• command_read_timeout (UInt64) — コマンドの stdout から読み取る際のタイムアウト (ミリ秒) 。
• command_write_timeout (UInt64) — コマンドの stdin に書き込む際のタイムアウト (ミリ秒) 。
• pool_size (UInt64) — コマンドプロセスのインスタンス数。'executable_pool' 型でのみ使用されます。
• send_chunk_header (UInt8) — 各データ chunk の前に行数を送信するかどうか (ブール値) 。
• execute_direct (UInt8) — コマンドを直接実行するか (1) 、/bin/bash 経由で実行するか (0) 。
• lifetime (UInt64) — リロード間隔 (秒) 。0 はリロードが無効であることを示します。
• deterministic (UInt8) — 関数が同じ引数に対して常に同じ結果を返すかどうか (ブール値) 。

例

すべての UDF とその読み込みステータスを表示:

SELECT
    name,
    load_status,
    type,
    command,
    return_type,
    argument_types
FROM system.user_defined_functions
FORMAT Vertical;

Row 1:
──────
name:           my_sum_udf
load_status:    Success
type:           executable
command:        /var/lib/clickhouse/user_scripts/sum.py
return_type:    UInt64
argument_types: ['UInt64','UInt64']

失敗した UDF を見つける:

SELECT
    name,
    loading_error_message
FROM system.user_defined_functions
WHERE load_status = 'Failed';

関連項目

• ユーザー定義関数 — UDF の作成と設定方法。