2.3 用户自定义函数
可以使用以下的方法来创建用户自定义的SQL函数:
typedef struct sqlite3_value sqlite3_value;
int
sqlite3_create_function(
sqlite3 *,
const char
*zFunctionName,
int nArg,
int eTextRep,
void*,
void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
void
(*xStep)(sqlite3_context*,int,sqlite3_value**),
void
(*xFinal)(sqlite3_context*)
);
int
sqlite3_create_function16(
sqlite3*,
const void
*zFunctionName,
int nArg,
int eTextRep,
void*,
void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
void
(*xStep)(sqlite3_context*,int,sqlite3_value**),
void
(*xFinal)(sqlite3_context*)
);
#define SQLITE_UTF8 1
#define SQLITE_UTF16 2
#define SQLITE_UTF16BE 3
#define
SQLITE_UTF16LE 4
#define SQLITE_ANY 5
nArg 参数用来表明自定义函数的参数个数. 如果参数值为0，则表示接受任意个数的参数. 用 eTextRep
参数来表明传入参数的编码形式. 参数值可以是上面的五种预定义值. SQLite3 允许同一个自定义函数有多种不同的编码参数的版本.
数据库引擎会自动选择转换参数编码个数最少的版本使用.
普通的函数只需要设置 xFunc 参数，而把 xStep 和 xFinal 设为NULL. 聚合函数则需要设置 xStep 和
xFinal 参数，然后把 xFunc 设为NULL. 该方法和使用sqlite3_create_aggregate() API一样.
sqlite3_create_function16()和sqlite_create_function()的不同就在于自定义的函数名一个要求是
UTF-16 编码，而另一个则要求是 UTF-8.
请注意自定函数的参数目前使用了sqlite3_value结构体指针替代了SQLite version 2.X中的字符串指针.
下面的函数用来从sqlite3_value结构体中提取数据:
const void *sqlite3_value_blob(sqlite3_value*);
int
sqlite3_value_bytes(sqlite3_value*);
int
sqlite3_value_bytes16(sqlite3_value*);
double
sqlite3_value_double(sqlite3_value*);
int
sqlite3_value_int(sqlite3_value*);
long long int
sqlite3_value_int64(sqlite3_value*);
const unsigned char
*sqlite3_value_text(sqlite3_value*);
const void
*sqlite3_value_text16(sqlite3_value*);
int
sqlite3_value_type(sqlite3_value*);
上面的函数调用以下的API来获得上下文内容和返回结果:
void *sqlite3_aggregate_context(sqlite3_context*, int
nbyte);
void *sqlite3_user_data(sqlite3_context*);
void
sqlite3_result_blob(sqlite3_context*, const void*, int n, void(*)(void*));
void sqlite3_result_double(sqlite3_context*, double);
void
sqlite3_result_error(sqlite3_context*, const char*, int);
void
sqlite3_result_error16(sqlite3_context*, const void*, int);
void
sqlite3_result_int(sqlite3_context*, int);
void
sqlite3_result_int64(sqlite3_context*, long long int);
void
sqlite3_result_null(sqlite3_context*);
void
sqlite3_result_text(sqlite3_context*, const char*, int n, void(*)(void*));
void sqlite3_result_text16(sqlite3_context*, const void*, int n,
void(*)(void*));
void sqlite3_result_value(sqlite3_context*,
sqlite3_value*);
void *sqlite3_get_auxdata(sqlite3_context*, int);
void sqlite3_set_auxdata(sqlite3_context*, int, void*, void
(*)(void*));
2.4 用户自定义排序规则
下面的函数用来实现用户自定义的排序规则:
sqlite3_create_collation(sqlite3*, const char *zName, int
eTextRep, void*,
int(*xCompare)(void*,int,const void*,int,const
void*));
sqlite3_create_collation16(sqlite3*, const void *zName, int
eTextRep, void*,
int(*xCompare)(void*,int,const void*,int,const
void*));
sqlite3_collation_needed(sqlite3*, void*,
void(*)(void*,sqlite3*,int eTextRep,const char*));
sqlite3_collation_needed16(sqlite3*, void*,
void(*)(void*,sqlite3*,int
eTextRep,const void*));
sqlite3_create_collation() 函数用来声明一个排序序列和实现它的比较函数.
比较函数只能用来做文本的比较. eTextRep 参数可以取如下的预定义值 SQLITE_UTF8, SQLITE_UTF16LE,
SQLITE_UTF16BE, SQLITE_ANY，用来表示比较函数所处理的文本的编码方式. 同一个自定义的排序规则的同一个比较函数可以有 UTF-8,
UTF-16LE 和 UTF-16BE 等多个编码的版本.
sqlite3_create_collation16()和sqlite3_create_collation() 的区别也仅仅在于排序名称的编码是 UTF-16
还是 UTF-8.
可以使用 sqlite3_collation_needed()
函数来注册一个回调函数，当数据库引擎遇到未知的排序规则时会自动调用该函数.
在回调函数中可以查找一个相似的比较函数，并激活相应的sqlite_3_create_collation()函数.
回调函数的第四个参数是排序规则的名称，同样sqlite3_collation_needed采用 UTF-8 编码.
sqlite3_collation_need16() 采用 UTF-16 编码.