這里說的SQL函數,是指可在SQL語句中使用的函數,如常見的 count(), sum(), avg(), min(), max() 等。?
在 sqlite 數據庫中,SQL函數被分為兩大類,一類稱作“Scalar function”,一類稱作“Aggregate function”。Scalar 和 Aggregate 實在不太清楚該怎么翻譯,而其含義,也難于用言語表達,大概屬于只可意會不可言傳的情況。通俗來說,Scalar函數基本等同于C/C++函數,而上面提到的 count(), sum() 等函數則屬于Aggregate函數。Aggregate函數不是根據參數直接得出結果,而是綜合了符合條件的所有記錄才最終計算出結果。
在 sqlite 中創建自定義SQL函數,需涉及以下接口函數:
int sqlite3_create_function(
? sqlite3 *db,
? const char *zFunctionName,
? int nArg,
? int eTextRep,
? void *pApp,
? void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
? void (*xStep)(sqlite3_context*,int,sqlite3_value**),
? void (*xFinal)(sqlite3_context*)
);
void *sqlite3_user_data(sqlite3_context*);
void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
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*);
sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
const unsigned char *sqlite3_value_text(sqlite3_value*);
const void *sqlite3_value_text16(sqlite3_value*);
const void *sqlite3_value_text16le(sqlite3_value*);
const void *sqlite3_value_text16be(sqlite3_value*);
int sqlite3_value_type(sqlite3_value*);
int sqlite3_value_numeric_type(sqlite3_value*);
void sqlite3_result_blob(sqlite3_context*, const void*, int, 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_error_toobig(sqlite3_context*);
void sqlite3_result_error_nomem(sqlite3_context*);
void sqlite3_result_error_code(sqlite3_context*, int);
void sqlite3_result_int(sqlite3_context*, int);
void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
void sqlite3_result_null(sqlite3_context*);
void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
void sqlite3_result_zeroblob(sqlite3_context*, int n);
要編寫sqlite3_create_function()所需的三個函數xFunc(), xStep(), xFinal(),不得不使用上面一堆接口函數,比較復雜的說。如果僅僅是單純的將以上函數一一對應到EF中,無疑是把復雜的工作轉稼給用戶,意義不大。(值得一提的是,在易語言的sqlite支持庫中,因為沒有找到比較優雅的解決方案,未提供創建自定義SQL函數的功能。) 通過對sqlite api進行包裝和再加工,我們在“易語言.飛揚”中提供了簡潔易用的、面向對象的、優雅的操作接口,在很大程度上簡化了創建自定義SQL函數的工作。
在“易語言.飛揚”中,要創建一個“Scalar function”,只需調用 SqliteDB.RegSQLScalarFunc(),傳入一個實現了接口 SQLScalarFunction 的對象即可:
public?interface?SQLScalarFunction
{
????public?文本?取函數名稱();
????public?整數?取參數個數();
????public?通用型,整數?執行(通用型[]?參數);
}
用戶的工作主要集中在接口方法“通用型,整數?執行(通用型[]?參數)”中(對應前面提到的xFunc),只需根據通用型數組參數計算出結果并返回即可。在這之前通過調用sqlite3_value_*系列函數獲取SQL參數,以及在這之后調用sqlite3_result_*系列函數將結果反饋到sqlite的工作,全部由類庫代勞。用戶接口非常簡潔。
在“易語言.飛揚”中,要創建一個“Aggregate function”,只需調用 SqliteDB.RegSQLAggregateFunc(),傳入一個實現了接口 SQLAggregateFunction 的對象即可:
public?interface?SQLAggregateFunction
{
????public?文本?取函數名稱();
????public?整數?取參數個數();
????public?SQLAggregateExecutor?創建執行者();
}
public?interface?SQLAggregateExecutor
{
????public?通用型,整數?單步執行(通用型[]?參數);
????public?通用型,整數?最終執行();
}
在一個Aggregate function被調用時,將自動調用“SQLAggregateFunction.創建執行者()”為該函數創建一個“執行者”對象(實現接口SQLAggregateExecutor)。為什么要創建“執行者”對象呢?因為Aggregate function是“上下文有關的”,每個函數調用都需要單獨維護各自的上下文信息。接口SQLAggregateExecutor中的方法“單步執行”“最終執行”分別對應前面提到的xStep,xFinal,聰明的您也許已經猜測到了。
“易語言.飛揚”sqlite類庫(sqlite.efn)提供的以上接口,簡潔易用、通俗易懂、面向對象、優雅大方,完全擺脫了sqlite api 的影子,是對原有接口的精心再加工,充分體現了我們“將復雜的事情簡單化”的決心。
(?注,以上涉及的類型名稱和方法名稱中英混用,也許是需要最終調整和完善的地方。)
根據以上接口,我們可以很輕松的實現自已版本的 sum() 函數——mysum():
public?class?MySum?<interfaces?=?SQLAggregateFunction>
{
????public?文本?取函數名稱()?{?返回?"mysum";?}
????public?整數?取參數個數()?{?返回?1;?}
????public?SQLAggregateExecutor?創建執行者()?{?返回?new?MySumExecutor();?}
????class?MySumExecutor?<interfaces?=?SQLAggregateExecutor>
????{
????????private?int?_sum?=?0;
????????public?通用型,整數?單步執行(通用型[]?參數)
????????{
????????????_sum?+=?參數[0];
????????}
????????public?通用型,整數?最終執行()?{?返回?(_sum,0);?}
????}
}