You need to enable JavaScript to run this app.
导航
创建自定义函数
最近更新时间:2024.12.03 17:46:08首次发布时间:2022.11.11 17:16:16

在 SQL 任务开发中,如果系统预置的内部函数无法满足业务需求时,可以选择创建自定义函数解决问题。

背景信息

UDF(User Defined Function)函数,即用户自定义函数。
系统已经内置了SUBSTRINGREPLACE等字符串操作函数,以及MAXMINAVG等聚合函数;但是内置函数也会出现无法支撑现实业务的时候,此时您可以选择自行编写代码逻辑来创建自定义函数,从而实现现实业务。

前提条件

您在创建 UDF 函数前,请自行完成编写代码,并构建 JAR 包。

  • 一般是由开发人员(Project_Dev)管理 UDF 函数,请确保操作者已被添加为项目成员并为其关联角色,请参见添加项目成员
  • UDF 函数使用的 JAR 包,文件名称要符合控制台要求,只能由大小写字母、数字、下划线(_)、短横线(-)和英文句号(.)组成。
  • 创建 UDF 函数时,需要指明所属元数据库,请先完成元数据库的创建。如何创建元数据库,请参见管理元数据

创建函数

  1. 登录流式计算 Flink 版控制台

  2. 在顶部菜单栏选择目标地域。

  3. 在左侧导航栏选择项目管理,然后单击项目卡片进入项目。

  4. 在项目左侧导航栏选择任务开发 > Jupyter lab,然后单击函数栏目,再单击创建函数的加号按钮。
    图片

  5. 创建函数对话框,设置自定义函数关键参数,然后单击确定
    图片

    配置

    说明

    创建类型

    根据实际需求选择 Flink 函数类型。

    • UDF:标量函数,作用是将一个值转换为另一个值,例如系统内置的SUBSTRINGREPLACE等字符串操作函数。
    • UDTF:表函数,作用是将一个值转为表中的一行数据(一变多)。
    • UDAF:聚合函数,作用是将多行数据的一组值,聚合为一个最终值(多变一),例如系统内置的MAXMINAVG等函数。

    函数名称

    自定义设置函数名称。
    支持小写字母、数字和下划线(_),字符长度范围为 1 ~ 128。

    所属数据库

    从下拉列表中选择目标元数据库。如果还未创建元数据库,请参见管理元数据

    函数类名

    与您即将上传的 JAR 文件中的类名保持一致。

    输入参数

    输入函数的入参。

    输出参数

    输入函数的出参。

    资源上传

    上传您的 UDF JAR 文件。
    系统要求您的 JAR 文件名称只能由大小写字母、数字、下划线(_)、短横线(-)和英文句号(.)组成。

其他操作

创建自定义函数后,支持您下载自定义函数文件和删除自定义函数。

  • 下载函数文件:单击下载按钮,即可下载自定义函数文件到本地。自定义函数文件是一个压缩包,包含 JAR 和 CRC 文件。
  • 删除函数:单击删除按钮,然后进行二次确认即可删除自定义函数。删除函数属于不可逆操作,请谨慎操作。