MySQL 8.3.0
Source Code Documentation
udf_registration_types.h File Reference
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  UDF_ARGS
 
struct  UDF_INIT
 Information about the result of a user defined function. More...
 

Typedefs

typedef struct UDF_ARGS UDF_ARGS
 
typedef struct UDF_INIT UDF_INIT
 Information about the result of a user defined function. More...
 
typedef void(* Udf_func_clear) (UDF_INIT *, unsigned char *, unsigned char *)
 
typedef void(* Udf_func_add) (UDF_INIT *, UDF_ARGS *, unsigned char *, unsigned char *)
 
typedef void(* Udf_func_deinit) (UDF_INIT *)
 
typedef bool(* Udf_func_init) (UDF_INIT *, UDF_ARGS *, char *)
 
typedef void(* Udf_func_any) (void)
 
typedef double(* Udf_func_double) (UDF_INIT *, UDF_ARGS *, unsigned char *, unsigned char *)
 
typedef long long(* Udf_func_longlong) (UDF_INIT *, UDF_ARGS *, unsigned char *, unsigned char *)
 
typedef char *(* Udf_func_string) (UDF_INIT *, UDF_ARGS *, char *, unsigned long *, unsigned char *, unsigned char *)
 

Enumerations

enum  Item_result {
  INVALID_RESULT = -1 , STRING_RESULT = 0 , REAL_RESULT , INT_RESULT ,
  ROW_RESULT , DECIMAL_RESULT
}
 Type of the user defined function return slot and arguments. More...
 
enum  Item_udftype { UDFTYPE_FUNCTION = 1 , UDFTYPE_AGGREGATE }
 

Typedef Documentation

◆ UDF_ARGS

typedef struct UDF_ARGS UDF_ARGS

◆ Udf_func_add

typedef void(* Udf_func_add) (UDF_INIT *, UDF_ARGS *, unsigned char *, unsigned char *)

◆ Udf_func_any

typedef void(* Udf_func_any) (void)

◆ Udf_func_clear

typedef void(* Udf_func_clear) (UDF_INIT *, unsigned char *, unsigned char *)

◆ Udf_func_deinit

typedef void(* Udf_func_deinit) (UDF_INIT *)

◆ Udf_func_double

typedef double(* Udf_func_double) (UDF_INIT *, UDF_ARGS *, unsigned char *, unsigned char *)

◆ Udf_func_init

typedef bool(* Udf_func_init) (UDF_INIT *, UDF_ARGS *, char *)

◆ Udf_func_longlong

typedef long long(* Udf_func_longlong) (UDF_INIT *, UDF_ARGS *, unsigned char *, unsigned char *)

◆ Udf_func_string

typedef char *(* Udf_func_string) (UDF_INIT *, UDF_ARGS *, char *, unsigned long *, unsigned char *, unsigned char *)

◆ UDF_INIT

typedef struct UDF_INIT UDF_INIT

Information about the result of a user defined function.

See also
Item_udf_func::update_used_tables()

Enumeration Type Documentation

◆ Item_result

Type of the user defined function return slot and arguments.

Enumerator
INVALID_RESULT 
STRING_RESULT 

not valid for UDFs

REAL_RESULT 

char *

INT_RESULT 

double

ROW_RESULT 

long long

DECIMAL_RESULT 

not valid for UDFs

char *, to be converted to/from a decimal

◆ Item_udftype

Enumerator
UDFTYPE_FUNCTION 
UDFTYPE_AGGREGATE