27.2.3.1. UDF 對簡單函數的調用順序

發布時間: 2012/8/17 17:59:48

下面介紹創建簡單UDF時需要定義的不同函數。27.2.3節，“添加新的自定義函數”中介紹了MySQL調用這些函數的順序。

如本節所示，應該說明主函數xxx()。注意返回值和參數會有所不同，這取決于你說明的SQL函數xxx()在CREATE FUNCTION聲明中返回的是STRING，INTEGER類型還是REAL類型示：

對于STRING 型函數：

char *xxx(UDF_INIT *initid, UDF_ARGS *args,
          char *result, unsigned long *length,
          char *is_null, char *error);

對于INTEGER型函數：

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

對于REAL型函數：

double xxx(UDF_INIT *initid, UDF_ARGS *args,
              char *is_null, char *error);

初始化和去初始化函數如下說明：電腦技巧www.boydavid.com

my_bool xxx_init(UDF_INIT *initid, UDF_ARGS *args, char *message);

void xxx_deinit(UDF_INIT *initid);

initid 參數被傳遞給所有的三個函數。它指向一個UDF_INIT 結構，這個結構被用來在函數之間交換信息。UDF_INIT 結構項跟隨著。初始化函數應該給任何它想要改變的項賦值。（要使用項的默認值，就讓它不被改變）

my_bool maybe_null

如果xxx() 能返回NULL，xxx_init()應maybe_null 為 1 。如果任一參量被說明了 maybe_null值，其默認值是1 。
unsigned int decimals

小數位數。默認值是傳到主函數的參量里小數的最大位數。（例如，如果函數傳遞 1.34, 1.345, 和1.3, 那么默認值為，因為1.345 有3位小數。
unsigned int max_length

結果的最大長度。max_length 的默認值因函數的結果類型而異。對字符串函數，默認值是最長參量的長度。對整型函數，默認是21位。對實型函數，默認是13再加上initid->decimals指示的小數位數。（對數字函數，長度包含正負號或者小數點符）。

如果想返回團值，你可以把max_length 設為從65KB到16MB。這個內存不會被分配，但是如果有臨時數據需要存儲，這個設置了的值被用來決定使用哪種列的類型。
char *ptr

函數可以用作本身目的的指針。比如，函數可以用initid->ptr 來在分配了的內存內部通訊。 xxx_init() 應該分配內存，并指派給這個指針：
```
initid->ptr = allocated_memory;
 電腦技術www.boydavid.com 
```
在 xxx() 和 xxx_deinit()中，借用 initid->ptr 來使用或分配內存。