system.user_defined_functions

Tabela do sistema que contém o status de carregamento e os metadados de configuração de Funções Definidas pelo Usuário (UDFs).

​

Descrição

Contém o status de carregamento, informações sobre erros e metadados de configuração para Funções Definidas pelo Usuário (UDFs).

​

Colunas

• name (String) — Nome da UDF.
• load_status (Enum8(‘Success’ = 0, ‘Failed’ = 1)) — Status de carregamento. Valores possíveis:
  • Success — UDF carregada e pronta para uso
  • Failed — Falha ao carregar a UDF (consulte o campo ‘loading_error_message’ para mais detalhes).
• loading_error_message (String) — Mensagem detalhada de erro quando o carregamento falha. Vazia se carregada com sucesso.
• last_successful_update_time (Nullable(DateTime)) — Timestamp da última atualização bem-sucedida. NULL se nunca tiver sido bem-sucedida.
• loading_duration_ms (UInt64) — Tempo gasto para carregar a UDF, em milissegundos.
• type (Enum8(‘executable’ = 0, ‘executable_pool’ = 1)) — Tipo da UDF: ‘executable’ (processo único) ou ‘executable_pool’ (pool de processos).
• command (String) — Script ou comando a ser executado para esta UDF.
• format (String) — Formato de dados para E/S (por exemplo, ‘TabSeparated’, ‘JSONEachRow’).
• return_type (String) — Tipo de retorno da função (por exemplo, ‘String’, ‘UInt64’).
• return_name (String) — Identificador opcional do valor de retorno. Vazio se não estiver configurado.
• argument_types (Array(String)) — Array com os tipos dos argumentos (por exemplo, [‘String’, ‘UInt64’]).
• argument_names (Array(String)) — Array com os nomes dos argumentos. Strings vazias para argumentos sem nome.
• max_command_execution_time (UInt64) — Número máximo de segundos para processar um bloco de dados. Apenas para o tipo ‘executable_pool’.
• command_termination_timeout (UInt64) — Segundos antes de enviar SIGTERM ao processo do comando.
• command_read_timeout (UInt64) — Milissegundos para ler da saída padrão do comando.
• command_write_timeout (UInt64) — Milissegundos para gravar na entrada padrão do comando.
• pool_size (UInt64) — Número de instâncias do processo de comando. Apenas para o tipo ‘executable_pool’.
• send_chunk_header (UInt8) — Indica se a contagem de linhas deve ser enviada antes de cada fragmento de dados (booleano).
• execute_direct (UInt8) — Indica se o comando deve ser executado diretamente (1) ou via /bin/bash (0).
• lifetime (UInt64) — Intervalo de recarga em segundos. 0 significa que a recarga está desabilitada.
• deterministic (UInt8) — Indica se a função retorna o mesmo resultado para os mesmos argumentos (booleano).

​

Exemplo

Veja todas as UDFs e o status de carregamento delas:

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

Encontre UDFs que falharam:

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

​

Veja também

• Funções Definidas pelo Usuário — Como criar e configurar UDFs.