自定义函数开发#

1. 背景#

虽然OpenMLDB内置了上百个函数，以供数据科学家作数据分析和特征抽取。但是在某些场景下还是不能很好的满足要求，以往只能通过开发内置函数来实现。内置函数开发需要重新编译二进制文件等待版本发布，周期相对较长。为了便于用户快速灵活实现特定的特征计算需求，我们实现了用户动态注册函数的机制。

一般SQL函数分为单行函数和聚合函数，目前我们只支持单行函数的自定义开发，预计下个版本会支持开发自定义聚合函数。关于单行函数和聚合函数的介绍可以参考这里

2. 开发步骤#

2.1 开发自定义函数#

2.1.1 C++函数名规范#

C++内置函数名统一使用snake_case风格
要求函数名能清晰表达函数功能
函数不能重名。函数名不能和内置函数及其他自定义函数重名。所有内置函数的列表参考这里

2.1.2 C++类型与SQL类型对应关系#

内置C++函数的参数类型限定为：BOOL类型，数值类型，时间戳日期类型和字符串类型。C++类型SQL类型对应关系如下：

SQL类型	C/C++ 类型
BOOL	`bool`
SMALLINT	`int16_t`
INT	`int32_t`
BIGINT	`int64_t`
FLOAT	`float`
DOUBLE	`double`
STRING	`StringRef`
TIMESTAMP	`Timestamp`
DATE	`Date`

2.1.3 函数参数和返回值#

返回值:

如果udf输出类型是基本类型，通过函数返回值返回
如果udf输出类型是string, timestamp, date, 通过函数最后一个参数返回

参数:

如果输入字段是基本类型，通过值传递
如果输入字段是string, timestamp, date, 通过指针传递

函数的第一个参数必须是UDFContext* ctx，不能更改。UDFContext的定义如下:

struct UDFContext {
    ByteMemoryPool* pool;  // 用来分配内存
    void* ptr;             // 用来存储临时变量。目前单行函数用不到
};

函数声明:

函数必须用extern “C”来声明

2.1.4 内存管理#

在自定义函数中，不允许使用new操作符或者malloc函数开辟空间。
若需要动态开辟空间，需要使用OpenMLDB提供的内存管理接口。函数执行完OpenMLDB会自动释放内存.
```
char *buffer = ctx->pool->Alloc(size);
```
一次分配空间的最大长度不能超过2M字节

2.1.5 函数实现#

包含头文件udf/openmldb_udf.h
实现自定义函数逻辑

#include "udf/openmldb_udf.h"  // 必须包含此头文件
 
// 实现一个udf，截取字符串的前两个字符
extern "C"
void cut2(UDFContext* ctx, StringRef* input, StringRef* output) {
    if (input == nullptr || output == nullptr) {
        return;
    }
    uint32_t size = input->size_ <= 2 ? input->size_ : 2;
    // 在udf函数中申请内存空间需要用ctx->pool
    char *buffer = ctx->pool->Alloc(size);
    memcpy(buffer, input->data_, size);
    output->size_ = size;
    output->data_ = buffer;
}

更多udf实现参考这里

2.2 编译动态库#

拷贝include目录 https://github.com/4paradigm/OpenMLDB/tree/main/include 到某个路径下，下一步编译会用到。如/work/OpenMLDB/
执行编译命令，其中 -I 指定inlcude目录的路径 -o 指定产出动态库的名称

g++ -shared -o libtest_udf.so examples/test_udf.cc -I /work/OpenMLDB/include -std=c++11 -fPIC

2.3 拷贝动态库#

需要把编译好的动态库拷贝到部署OpenMLDB tablet/taskmanager目录中的udf目录下。如果没有此目录需要创建一个。需要注意的是tablet的udf目录和bin/conf目录平级，taskmanager是放到taskmanager/bin/udf目录里。如tablet和taskmanager的部署目录都是/work/openmldb，目录结构如下：
```
/work/openmldb/
├── bin
├── conf
├── taskmanager
│   ├── bin
│   │   ├── taskmanager.sh
│   │   └── udf
│   │       └── libtest_udf.so
│   ├── conf
│   └── lib
├── tools
└── udf
    └── libtest_udf.so
```
每个tablet的目录都需要拷贝
在DROP FUNCTION之前不能删除此目录里的动态库

2.4 注册、删除和查看函数#

注册函数使用CREATE FUNCTION

CREATE FUNCTION cut2(x STRING) RETURNS STRING OPTIONS (FILE='libtest_udf.so');

注:

参数类型和返回值类型必须和代码的实现保持一致
一个udf函数只能对一种类型起作用。如果想用于多种类型，需要创建多个函数
FILE 指定动态库的文件名，不需要包含路径

成功注册后就可以使用函数了

SELECT cut2(c1) FROM t1;

可以通过SHOW FUNCTIONS查看注册的函数

SHOW FUNCTIONS;

通过DROP FUNCTION删除已经注册的函数

DROP FUNCTION cut2;

自定义函数开发

Contents