system.user_defined_functions

Tabla del sistema que contiene el estado de carga y los metadatos de configuración de las funciones definidas por el usuario (UDFs).

​

Descripción

Contiene el estado de carga, información sobre errores y metadatos de configuración de las funciones definidas por el usuario (UDFs).

​

Columnas

• name (String) — Nombre de la UDF.
• load_status (Enum8(‘Success’ = 0, ‘Failed’ = 1)) — Estado de carga. Valores posibles:
  • Success — UDF cargada y lista para usar
  • Failed — Error al cargar la UDF (consulte el campo ‘loading_error_message’ para obtener más detalles).
• loading_error_message (String) — Mensaje de error detallado cuando falla la carga. Vacío si se cargó correctamente.
• last_successful_update_time (Nullable(DateTime)) — Marca temporal de la última actualización correcta. NULL si nunca se completó correctamente.
• loading_duration_ms (UInt64) — Tiempo empleado en cargar la UDF, en milisegundos.
• type (Enum8(‘executable’ = 0, ‘executable_pool’ = 1)) — Tipo de UDF: ‘executable’ (proceso único) o ‘executable_pool’ (grupo de procesos).
• command (String) — Script o comando que se ejecuta para esta UDF.
• format (String) — Formato de datos para E/S (p. ej., ‘TabSeparated’, ‘JSONEachRow’).
• return_type (String) — Tipo de retorno de la función (p. ej., ‘String’, ‘UInt64’).
• return_name (String) — Identificador opcional del valor de retorno. Vacío si no está configurado.
• argument_types (Array(String)) — Array de tipos de argumentos (p. ej., [‘String’, ‘UInt64’]).
• argument_names (Array(String)) — Array de nombres de argumentos. Cadenas vacías para argumentos sin nombre.
• max_command_execution_time (UInt64) — Número máximo de segundos para procesar un bloque de datos. Solo para el tipo ‘executable_pool’.
• command_termination_timeout (UInt64) — Segundos antes de enviar SIGTERM al proceso del comando.
• command_read_timeout (UInt64) — Milisegundos para leer de la salida estándar del comando.
• command_write_timeout (UInt64) — Milisegundos para escribir en la entrada estándar del comando.
• pool_size (UInt64) — Número de instancias del proceso del comando. Solo para el tipo ‘executable_pool’.
• send_chunk_header (UInt8) — Indica si se envía el recuento de filas antes de cada fragmento de datos (booleano).
• execute_direct (UInt8) — Indica si el comando se ejecuta directamente (1) o mediante /bin/bash (0).
• lifetime (UInt64) — Intervalo de recarga en segundos. 0 significa que la recarga está deshabilitada.
• deterministic (UInt8) — Indica si la función devuelve siempre el mismo resultado para los mismos argumentos (booleano).

​

Ejemplo

Consulte todas las UDF y su estado de carga:

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']

Encontrar UDFs que fallaron:

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

​

Véase también

• Funciones definidas por el usuario — Cómo crear y configurar UDFs.