xxx()

主要功能。这是计算函数结果的地方。SQL 函数数据类型与 C++ 函数的返回类型之间的对应关系如下所示。

也可以声明一个 DECIMAL函数，但返回的值是一个字符串，所以你应该像写函数一样编写STRING 函数。ROW功能没有实现。

xxx_init()

的初始化函数xxx()。如果存在，它可用于以下目的：

xxx_deinit()

的去初始化函数 xxx()。如果存在，它应该释放初始化函数分配的任何内存。

xxx_clear()

重置当前聚合值但不插入参数作为新组的初始聚合值。

xxx_add()

将参数添加到当前聚合值。

bool maybe_null

xxx_init()应该设置 maybe_null为1if xxx()can return NULL。默认值是 1是否声明了任何参数 maybe_null。

unsigned int decimals

小数点右边的小数位数。默认值是传递给主函数的参数中的最大小数位数。例如，如果函数传递 1.34、1.345和 1.3，则默认值为 3，因为 1.345有 3 个小数位。

对于没有固定小数位数的参数，该 值设置为 31，比、 和 数据类型decimals允许的最大小数位数多 1 。该值可用作 头文件 中 的常量。DECIMALFLOATDOUBLENOT_FIXED_DECmysql_com.h

值decimals31 用于参数，如声明的 FLOAT或 DOUBLE列没有明确的小数位数（例如， FLOAT而不是 FLOAT(10,3)）和浮点常量，如1345E-3. 它还用于可能在函数内转换为数字形式的字符串和其他非数字参数。

成员初始化的值decimals只是默认值。它可以在函数内更改以反映实际执行的计算。默认值被确定为使用参数的最大小数位数。如果小数位数是NOT_FIXED_DEC偶数之一的参数，那就是用于 的值 decimals。

unsigned int max_length

结果的最大长度。默认 max_length值因函数的结果类型而异。对于字符串函数，默认值为最长参数的长度。对于整数函数，默认值为 21 位。对于实函数，默认值为 13 加上由 指示的小数位数initid->decimals。（对于数字函数，长度包括任何符号或小数点字符。）

如果要返回 blob 值，可以设置 max_length为 65KB 或 16MB。此内存未分配，但如果需要临时存储数据，则该值用于决定使用哪种数据类型。

char *ptr

函数可用于其自身目的的指针。例如，函数可以用来 initid->ptr在它们之间传递分配的内存。xxx_init() 应该分配内存并将其分配给此指针：

initid->ptr = allocated_memory;

在xxx()和 xxx_deinit()中，指的 initid->ptr是使用或释放​​内存。

bool const_item

xxx_init()如果 总是返回相同的值，则应设置 const_item为，否则应设置为。 1xxx()0

xxx_reset()

当 MySQL 找到新组中的第一行时调用此函数。它应该重置任何内部摘要变量，然后使用给定的 UDF_ARGS参数作为组的内部摘要值中的第一个值。声明 xxx_reset()如下：

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

xxx_reset()在 MySQL 8.0 中不需要或使用，其中使用可加载函数接口xxx_clear()。但是，您可以同时定义两者 xxx_reset()， xxx_clear()如果您想让您的函数与旧版本的服务器一起使用。（如果确实包含这两个函数， xxx_reset()在许多情况下，该函数可以通过调用 xxx_clear()重置所有变量，然后调用xxx_add()将 UDF_ARGS参数添加为组中的第一个值来在内部实现。）

xxx_clear()

当 MySQL 需要重置汇总结果时调用此函数。它在每个新组的开头被调用，但也可以被调用以重置没有匹配行的查询的值。声明 xxx_clear()如下：

void xxx_clear(UDF_INIT *initid, char *is_null, char *error);

is_nullCHAR(0)在调用 之前 设置为指向 xxx_clear()。

如果出现问题，您可以在error参数指向的变量中存储一个值。error指向单字节变量，而不是字符串缓冲区。

xxx_clear()MySQL 8.0 要求。

xxx_add()

为属于同一组的所有行调用此函数。您应该使用它将 UDF_ARGS参数中的值添加到内部摘要变量。

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

unsigned int arg_count

参数的数量。如果您需要使用特定数量的参数调用您的函数，请在初始化函数中检查此值。例如：

if (args->arg_count != 2)
{
    strcpy(message,"XXX() requires two arguments");
    return 1;
}

对于数组的其他UDF_ARGS成员值，数组引用是从零开始的。也就是说，使用从 0 到 args->arg_count- 1 的索引值引用数组成员。

enum Item_result *arg_type

指向包含每个参数类型的数组的指针。可能的类型值为 STRING_RESULT、 INT_RESULT、 REAL_RESULT和 DECIMAL_RESULT。

要确保参数属于给定类型，如果不是则返回错误，请检查 arg_type初始化函数中的数组。例如：

if (args->arg_type[0] != STRING_RESULT ||
    args->arg_type[1] != INT_RESULT)
{
    strcpy(message,"XXX() requires a string and an integer");
    return 1;
}

类型参数DECIMAL_RESULT作为字符串传递，因此您可以像处理值一样处理它们 STRING_RESULT。

作为要求函数的参数为​​特定类型的替代方法，您可以使用初始化函数将arg_type元素设置为您想要的类型。这会导致 MySQL 在每次调用 xxx(). 例如，要指定前两个参数应分别强制为字符串和整数，请在以下位置执行此操作 xxx_init()：

args->arg_type[0] = STRING_RESULT;
args->arg_type[1] = INT_RESULT;

精确值十进制参数（例如 1.3或 DECIMAL列值）以 类型传递DECIMAL_RESULT。但是，这些值作为字符串传递。要接收数字，请使用初始化函数指定应将参数强制转换为一个 REAL_RESULT值：

args->arg_type[2] = REAL_RESULT;

char **args

args->args将有关传递给函数的参数的一般性质的信息传递给初始化函数。对于常量参数i， args->args[i]指向参数值。（有关如何正确访问该值的说明，请参阅后面的内容。）对于非常量参数， args->args[i]是 0. 常量参数是仅使用常量的表达式，例如3or 4*7-2或 SIN(3.14)。非常量参数是一个表达式，它引用可能在行与行之间发生变化的值，例如列名或使用非常量参数调用的函数。

对于主函数的每次调用， args->args包含为当前正在处理的行传递的实际参数。

如果参数i表示 NULL， args->args[i]则为空指针 (0)。如果参数不是NULL，函数可以按如下方式引用它：

unsigned long *lengths

对于初始化函数， lengths数组指示每个参数的最大字符串长度。你不应该改变这些。对于主函数的每次调用， lengths包含为当前正在处理的行传递的任何字符串参数的实际长度。对于 INT_RESULTor 类型的参数REAL_RESULT，lengths 仍然包含参数的最大长度（对于初始化函数）。

char *maybe_null

对于初始化函数，该 maybe_null数组指示每个参数的参数值是否可能为空（如果否则为 0，如果是则为 1）。

char **attributes

args->attributes传达有关函数参数名称的信息。对于 argument i，属性名称可作为字符串使用 args->attributes[i]，属性长度为 args->attribute_lengths[i]。不要假设字符串以 null 结尾。

默认情况下，函数参数的名称是用于指定参数的表达式的文本。对于可加载函数，参数也可以有一个可选 子句，在这种情况下参数名称是 . 因此，每个参数的 值取决于是否给出了别名。 [AS] alias_namealias_nameattributes

假设一个可加载函数 my_udf()被调用如下：

SELECT my_udf(expr1, expr2 AS alias1, expr3 alias2);

在这种情况下，attributes和 attribute_lengths数组将具有以下值：

args->attributes[0] = "expr1"
args->attribute_lengths[0] = 5

args->attributes[1] = "alias1"
args->attribute_lengths[1] = 6

args->attributes[2] = "alias2"
args->attribute_lengths[2] = 6

unsigned long *attribute_lengths

该attribute_lengths数组指示每个参数名称的长度。

关于它们传递给可加载函数的参数，应用程序将继续工作，因为该函数现在能够处理任何字符集中的字符串参数，包括二进制字符串。

如果可加载函数要以不同于其参数字符集的字符集返回字符串结果，则该函数必须在内部执行字符集转换。例如，如果函数接受latin1参数但返回utf8mb4结果，就会出现这种情况。

metaphon()返回字符串参数的元音字符串。这有点像 soundex 字符串，但更适合英语。

myfunc_double()返回其参数中字符的 ASCII 值之和除以其参数长度之和。

myfunc_int()返回其参数长度的总和。

sequence([const int])返回从给定数字开始的序列，如果没有给出数字则返回 1。

lookup()返回主机名的 IP 地址。

reverse_lookup()返回 IP 地址的主机名。该函数可以使用 form 的单个字符串参数 'xxx.xxx.xxx.xxx'或四个数字调用。

avgcost()返回平均成本。这是一个聚合函数。