Havenask进阶系列【UDF定制】-阿里云开发者社区

一、UDF介绍

Havenask SQl 支持在查询语句中使用内置的 UDF，直译即用户自定义函数。同时也允许客户以插件的形式定制 UDF，客户可以自己开发并编译新的Havenask镜像以使用自定义的 UDF。
Havenask 中已经有一些内置的 UDF，用户可以直接在查询中使用，例如用户可以通过 contain 函数判断某个字段的值是否在一个给定的集合内，或者使用MATCHINDEX和 QUERY 数查询倒排索引。
还有可以计算向量查询分数或者文本匹配分的一些UDF，用户可以自行在查询中直接使用。

内置UDF列表

1、使用示例 A

例如 contain 函数，它的函数原型有以下6种，功能是判断第一个参数A中是否包含第二个参数 B中描述的内容。参数A可以是单值或多值的 int32、int64、string类型的字段，参数B为常量string表达式，表示的是一个给定的集合。集合的每个元素之间用竖线分割，返回值是布尔类型，表示参数 A的字段中是否包含参数 B所描述的集合。

?原型

boolean contain(int32 a, const string b)

boolean contain(int64 a, const string b)

boolean contain(string a, const string b)

boolean contain(ARRAY a, const string b)

?说明

?判断单值或多值a中是否包含b中描述的内容

?参数

?参数a：输入为单值多值的int32/int64/string 类型

?参数b：输入为常量string表达式，用 | 分隔，表示满足任意一项即可

?返回值

?boolean类型返回，表示参数a是否包含参数b中描述的集合

2、使用示例 B

例如用 contain 来检索 nid字段值在【1,2.3】这个集合中的所有记录。可以这样写 WHERE 子句：先将目标字段 nid作为 contain 的第一个参数，然后将给定的集合 1,2,3用以竖线分割的形式与成常量字符串作为 contain 函数的第二个参数。就能够通过 contain 检索到 nid 字段值在集合 1,2,3中的所有记录。

SELECT nid, price, brand, size FROM phone WHERE contain(nid, '1|2|3') ORDER BY nid LIMIT 100

USE_TIME: 0.059, ROW_COUNT: 3


------------------------------- TABLE INFO ---------------------------
nid   | price   | brand   | size  |
1   | 3599  | Huawei  | 5.9   |
2   | 4388  | Huawei  | 5.5   |
3     | 899     | Xiaomi  | 5     |

二、UDF开发及配置

1、UDF的开发

UDF的开发，可以参考udf_plugins路径下其他 UDF函数的实现，自定义 UDF 主要需要实现以下几个函数。

beginRequest函数，在 Query 开始时调用，可以初始化一些变量供后续使用。
evaluate 函数，在运行的过程中调用，将每条数据的相应字段送入该函数进行运算，并将 evaluate 的返回值作为最终结果。
creator 类的create Function 函数，用来创建 UDF 函数对象，可以做一些参数的检查，或者根据 UDF 的入参来创建不同的函数对象。开发完 UDF 的函数类和 creator 类之后需要在 HavenaskUdfFactory 中注册UDF。然后重新打包run time 镜像后才能使用新的自定义 UDF。

2、UDF注册

开发完UDF的函数类和creator类之后，需要在HavenaskUdfFactory中注册这个UDF，然后重新打包runtime镜像后才能使用新的自定义UDF。

3、UDF配置

打镜像前还需要在 sql_function.json 配置中注册 UDF 原型，配置时可以参考每一项配置的说明。

插件名称
插件类型为UDF
is_determinisitic 表示输入相同时函数输出是否确定
额外补充信息，例如UDF 中会使用到的 match data 的类型
函数原型，其中也包括参数列表和返回值类型，可以注册多个函数原型

{
    "functions": [
        {
            "function_name": "cheap",                      // 1
            "function_type": "UDF",                         // 2
            "is_deterministic": 1,                          // 3
            "function_content_version": "json_default_0.1",
            "function_content": {
                "properties" : {},                          // 4
                "prototypes": [                             // 5
                    {
                        "params": [                         // 6
                            {
                                "is_multi": false,
                                "type": "double"
                            }
                        ],
                        "returns": [                        // 7
                            {
                                "is_multi": false,
                                "type": "boolean"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

三、实际操作演示

首先进入ha3 dev 镜像，所有的开发都是在该镜像中完成，然后进入udf_plugins 目录。新建一个子目录cheap。我们将实现一个叫 cheap 的 UDF，功能是判断一个字段的值是否小于2.000。此处已经写好了函数的相关实现，可以进去看一下具体的实现细节。
首先来看一下头文件，头文件中包含了两个类，一个是 function 类，一个是 functionCreator 类。先来看 function 类，function 类接收一个 double 类型的字段作为输入然后在 query 开始时会调用 beginRequest函数，做一些初始化相关的操作。然后是 evaluate 函数，运行时会将每一条数据的相应字段，送入该函数进行运算，返回值作为最终的运算结果。这里 cheap 函数的作用是判断一个字段值是否小于 2000，所以返回值是一个布尔类型。

再来看 functionCreator 类，这个类需要实现一个 createFunction 函数用来创建 function 类的对象。

再来看一下 CPP 文件，文件中是具体的函数实现。因为 cheap 函数实现比较简单，beginRequest没有需要做的事情，直接返回true 即可。evaluate 函数直接使用function 对象的 _pAttr 成员变量做一个判断，返回判断的结果即可。_pAttr 成员变量是在创建function 对象时通过构造函数传入。注意此处需要先调用getValue，才能从字段中获取到真正的值。functionCreator类的createFunction 函数的入参是查询语句中给 UDF 传入的参数，是一个 vector。我们可以在此处做一些参数的校验，先检查了入参不为空，然后又判断第一个字段不是多值类型的，防止创建函数出错。随后将 vector 的第一个元素作为 cheap 函数要判断的字段传入 UDF 对象中。然后需要在 Havenask UdfFactory.cpp中，注册该函数，此处仿照其他 UDF 的注册方法注册cheap 函数。

接下来打开 udf_plugins 目录下的 BUILD 文件，将刚刚添加的cheap 目录下的所有 cpp 文件和头文件都加入 BUILD 文件的目标中。

然后进入 sql目录下的misc 文件夹。编辑sql_function.json 配置文件，在最后加上我们的 cheap 的声明。开发都已完成。然后回到 Havenask 目录使用 build.sh 脚本编译代码。

此处已经编译好。然后需要到容器的外边进入 docker目录下的runtime 子目录，将 bazel-bin 下刚刚编译好的hape_tar.tar 文件复制到子目录下。

复制好之后需要使用docker build 的命令，打包一个新的镜像。例如镜像叫做ha3_runtime_udf。然后耐心等待镜像打包完成。打包完成后可以使用 docker 命令看到刚刚打好的镜像。可以看到这里已经有刚刚打好的ha3_runtime_udf镜像。

然后更改 global.conf 配置，将所有的镜像都替换成ha3_runtime_udf。

这样下次使用hape 命令时就会使用刚刚打包好的镜像。然后使用hape 命令启动 havenask 服务，此处已经提前搭建好了一个 Havenask 服务，并且新建了一个商品表。先看看表里都有哪些数据。

可以看到表中有商品id、商品 title 和商品price 字段，有的商品 price 价格大于 2.000 。可以通过在 WHERE 子句中使用定制好的 cheap 函数将价格大于2.000 的商品过滤掉。通过在原有查询中加上 WHERE 子句，将 price 字段传给 cheap 函数就可以得到过滤后的结果，可以看到所有价格大于2.000 的商品都已经被过滤。