更新时间:2026-11-06 GMT+08:00
分享

CREATE FUNCTION

概述

CREATE FUNCTION语句用于在当前Catalog中注册用户自定义函数(UDF),包括标量函数、表函数和聚合函数。注册后的函数可在SQL查询中像内置函数一样使用。

适用场景

  • 业务逻辑封装:将复杂的业务计算逻辑封装为UDF,在SQL中简洁调用。
  • 格式转换:自定义数据格式解析函数,处理非标准JSON、XML等数据。
  • 加密脱敏:实现自定义加密、脱敏算法,满足数据安全要求。

约束与限制

  • AI DataLake不支持TEMPORARY关键字,无法创建临时函数。
  • 自定义函数的JAR包需提前上传至集群,确保类路径可访问。
  • 函数类必须实现Flink对应的UDF接口(如ScalarFunction、TableFunction、AggregateFunction)。
  • 函数名在同一个数据库内必须唯一。

语法结构

CREATE [SYSTEM] FUNCTION
[IF NOT EXISTS] [catalog_name.][db_name.]function_name
AS class_identifier
[LANGUAGE JAVA|SCALA|PYTHON]

语法说明

参数

必填

说明

SYSTEM

否

声明为系统函数。系统函数的解析优先级高于内置函数,可覆盖同名内置函数的行为。

IF NOT EXISTS

否

指定当同名函数已存在时不报错。未指定时若同名函数存在则抛出异常。

function_name

是

函数名称,在数据库内必须唯一。可指定catalog_name和db_name前缀。

class_identifier

是

UDF实现类的全限定类名。该类必须实现Flink对应的UDF接口,且JAR包已在集群中可用。

LANGUAGE

否

指定UDF的实现语言,支持JAVA、SCALA、PYTHON。默认为JAVA。Python UDF需额外配置Python环境。

使用示例

示例:创建Java自定义函数

-- 创建DataGen源表
CREATE TABLE datagen_source (
id BIGINT,
raw_text STRING
) WITH (
'connector' = 'datagen',
'rows-per-second' = '10',
'fields.id.kind' = 'sequence',
'fields.id.start' = '1',
'fields.id.end' = '1000',
'fields.raw_text.length' = '10'
);
-- 创建Print结果表
CREATE TABLE print_sink (
id BIGINT,
processed_text STRING
) WITH (
'connector' = 'print'
);
-- 注册自定义函数
CREATE FUNCTION IF NOT EXISTS my_udf AS 'com.example.MyScalarFunction';
-- 提交作业
INSERT INTO print_sink
SELECT id, my_udf(raw_text) AS processed_text
FROM datagen_source;

相关文档