mysql udf c 示例_MySQL 数据库用户自定义函数UDF的API介绍和UDF开发示例 | IT工程师的生活足迹...

一、UDF 自定义函数API接口说明

MySQL 数据库UDF用户自定义开发函数的API接口说明如下：

1.1、name_init

my_boolname_init(UDF_INIT *initid, UDF_ARGS *args, char *message)

请自行了解UDF_INIT 结构体和UDF_ARGS结构体

Message：用于打印错误信息

1.2、name_deinit

void name_deinit(UDF_INIT*initid)

该函数会进行一些内存释放和清理的工作，在之前我们提到initid->ptr，我们可以在该区域·进行内存的动态分配，这里就可以直接进行内存释放。

1.3、name()

针对不同的返回值类型，如：STRING\DECIMAL\INTEGER\REAL

1.4、name_add()和name_clear()

void name_add(UDF_INIT *initid, UDF_ARGS *args, char *is_null,char *error)

void name_clear(UDF_INIT *initid, char *is_null, char *error)

对于聚合类型的UDF，name_addd和name_clear会被反复调用

二、两个示例

下一个单次调用型函数，一个聚集类型函数，来描述写一个UDF的过程。

2.1、示例一

接受一个参数，并返回该参数的值

//初始化

my_booludf_int_init(UDF_INIT *initid, UDF_ARGS *args, char *message)

{

if (args->arg_count != 1){ //检查参数个数

strcpy(message, "udf_intexample() can onlyaccept one argument");

return 1;

}

if (args->arg_type[0] != INT_RESULT){ //检查参数类型

strcpy(message, "udf_intexample() argumenthas to be an integer");

return 1;

}

return 0;

}

//清理操作

voidudf_int_deinit(UDF_INIT *initid)

{

}

//主函数

long long udf_int(UDF_INIT *initid, UDF_ARGS *args, char *is_null, char *error)

{

long long num = (*(long long *)args->args[0]); //获取第一个参数值

return num;

}

2.2、示例二

接受一个浮点数类型的参数，并对每个分组进行求和

//初始化

my_booludf_floatsum_init(UDF_INIT *initid, UDF_ARGS *args, char *message)

{

double *total = (double *) malloc (sizeof(double));

if (total == NULL){ //内存分配失败

strcpy(message,"udf_floatsum:alloc mem failed!");

return 1;

}

*total = 0;

initid->ptr = (char *)total;

if (args->arg_count != 1){ //检查参数个数

strcpy(message, "too moreargs,only one!");

return 1;

}

if (args->arg_type[0] != REAL_RESULT){ //检查参数类型

strcpy(message, "wrongtype");

return 1;

}

initid->decimals = 3; //设置返回值精度

return 0;

}

//清理、释放在init函数中分配的内存

voidudf_floatsum_deinit(UDF_INIT *initid)

{

free(initid->ptr);

}

//每一行都会调用到该函数

voidudf_floatsum_add(UDF_INIT *initid, UDF_ARGS *args, char *is_null, char *error)

{

double* float_total;

float_total = (double*)initid->ptr;

if (args->args[0])

*float_total += *(double*)args->args[0];

}

//每个分组完成后，返回结果

doubleudf_floatsum(UDF_INIT *initid, UDF_ARGS *args, char *is_null, char *error)

{

double* float_total;

float_total = (double *)initid->ptr;

return *float_total;

}

//在进行下一个分组前调用，设置initid->ptr指向的值为0，以便下一次分组统计

voidudf_floatsum_clear(UDF_INIT *initid, char *is_null, char *error)

{

double *float_total;

float_total = (double *)initid->ptr;

*float_total = 0;

}