Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

CREATE FUNCTION

Cria uma função definida pelo usuário (UDF) a partir de uma expressão lambda. A expressão deve ser composta por parâmetros da função, constantes, operadores ou outras chamadas de função.

Sintaxe

CREATE [OR REPLACE] FUNCTION name [ON CLUSTER cluster] AS (parameter0, ...) -> expression

Uma função pode ter um número arbitrário de parâmetros.

Há algumas restrições:

  • O nome de uma função deve ser único entre as funções definidas pelo usuário e as funções do sistema.
  • Funções recursivas não são permitidas.
  • Todas as variáveis usadas por uma função devem ser especificadas na lista de parâmetros dela.

Se alguma restrição for violada, uma exceção será lançada.

Exemplo

Querysql
CREATE FUNCTION linear_equation AS (x, k, b) -> k*x + b;
SELECT number, linear_equation(number, 2, 1) FROM numbers(3);
Responsetext
┌─number─┬─plus(multiply(2, number), 1)─┐
│      0 │                            1 │
│      1 │                            3 │
│      2 │                            5 │
└────────┴──────────────────────────────┘

Uma função condicional é usada em uma função definida pelo usuário na consulta a seguir:

Querysql
CREATE FUNCTION parity_str AS (n) -> if(n % 2, 'odd', 'even');
SELECT number, parity_str(number) FROM numbers(3);
Responsetext
┌─number─┬─if(modulo(number, 2), 'odd', 'even')─┐
│      0 │ even                                 │
│      1 │ odd                                  │
│      2 │ even                                 │
└────────┴──────────────────────────────────────┘

Substitua uma UDF existente:

Querysql
CREATE FUNCTION exampleReplaceFunction AS frame -> frame;
SELECT create_query FROM system.functions WHERE name = 'exampleReplaceFunction';
CREATE OR REPLACE FUNCTION exampleReplaceFunction AS frame -> frame + 1;
SELECT create_query FROM system.functions WHERE name = 'exampleReplaceFunction';
Responsetext
┌─create_query─────────────────────────────────────────────┐
│ CREATE FUNCTION exampleReplaceFunction AS frame -> frame │
└──────────────────────────────────────────────────────────┘

┌─create_query───────────────────────────────────────────────────┐
│ CREATE FUNCTION exampleReplaceFunction AS frame -> (frame + 1) │
└────────────────────────────────────────────────────────────────┘
Navigation