Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

CREATE FUNCTION

Crea una función definida por el usuario (UDF) a partir de una expresión lambda. La expresión debe componerse de parámetros de la función, constantes, operadores u otras llamadas a funciones.

Sintaxis

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

Una función puede tener un número arbitrario de parámetros.

Hay algunas restricciones:

  • El nombre de una función debe ser único entre las funciones definidas por el usuario y las del sistema.
  • No se permiten las funciones recursivas.
  • Todas las variables que use una función deben especificarse en su lista de parámetros.

Si se incumple alguna de estas restricciones, se genera una excepción.

Ejemplo

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 │
└────────┴──────────────────────────────┘

En la siguiente consulta, se invoca una función condicional dentro de una función definida por el usuario:

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                                 │
└────────┴──────────────────────────────────────┘

Reemplazar una 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