SQLite使用(三)&&核心API使用

時間 2019-12-06

標籤 sqlite 使用核心 api 欄目 Sqlite 简体版

原文原文鏈接

概述
SQLite提供了一系列接口供用戶訪問數據庫，主要包括鏈接數據庫，處理SQL，迭代查詢結果等。本文會針對咱們使用SQLite的主要場景，列出核心的API，詳細介紹API的用法並給出代碼用例。
1.打開關閉數據庫
sqlite3_open_v2
原型：sql

int sqlite3_open_v2(
const char *filename, /* Database filename (UTF-8) */
sqlite3 **ppDb, /* OUT: SQLite db handle */
int flags, /* Flags */
const char *zVfs /* Name of VFS module to use */
);

做用：打開一個數據庫鏈接
關鍵的參數：flags
SQLITE_OPEN_NOMUTEX: 設置數據庫鏈接運行在多線程模式(沒有指定單線程模式的狀況下)
SQLITE_OPEN_FULLMUTEX：設置數據庫鏈接運行在串行模式。
SQLITE_OPEN_SHAREDCACHE：設置運行在共享緩存模式。
SQLITE_OPEN_PRIVATECACHE：設置運行在非共享緩存模式。
SQLITE_OPEN_READWRITE：指定數據庫鏈接能夠讀寫。
SQLITE_OPEN_CREATE：若是數據庫不存在，則建立。數據庫

sqlite3_close_v2
原型：緩存

int sqlite3_close_v2(sqlite3*);

做用：關閉數據庫鏈接，若關閉時鏈接上有未提交的事務，該事務會自動回滾。多線程

1.1 例子：打開關閉數據庫鏈接函數

sqlite3* pDb;
char* filename="/u01/sqlite/test.db";
sqlite3_open_v2(filename, &pDb, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_NOMUTEX | SQLITE_OPEN_SHAREDCACHE, NULL);
....
....
sqlite3_close_v2(pDb);

打開數據庫文件test.db,對應的數據庫鏈接可讀可寫，以多線程模式運行，而且運行在共享緩存模式，執行完操做後，關閉數據庫鏈接。lua

2.更新SQL
更新SQL主要包括建立表，插入，刪除，更新記錄等，SQLite中經常使用的更新API有兩個，一個是sqlite3_exec，另一個是sqlite3_prepare_v2。spa

2.1 sqlite3_exec
原型：線程

int sqlite3_exec(
sqlite3*, /* An open database */
const char *sql, /* SQL to be evaluated */
int (*callback)(void*,int,char**,char**), /* Callback function */
void *, /* 1st argument to callback */
char **errmsg /* Error msg written here */
);

其中參數sql能夠包含多個SQL命令，語句之間以分號隔開，sqlite3_exec()將解析和執行sql字符串中的每一個命令，直到到達該字符串的末尾或遇到錯誤。對於運行修改數據庫的命令(建立，插入，刪除，更新)很是適合，一個函數調用就能夠完成所有操做。須要注意的是，雖然sqlite3_exec()能夠執行多個SQL命令，可是函數不保證事務，即已執行成功的語句，不會由於後面執行失敗的語句而回滾。code

2.2 sqlite3_perpare_v2
原型：sqlite

int sqlite3_prepare_v2(
sqlite3 *db, /* Database handle */
const char *zSql, /* SQL statement, UTF-8 encoded */
int nByte, /* Maximum length of zSql in bytes. */
sqlite3_stmt **ppStmt, /* OUT: Statement handle */
const char **pzTail /* OUT: Pointer to unused portion of zSql */
);

sqlite3_exec其實是將編譯，執行進行了封裝，與之等價的一組函數是 sqlite3_prepare_v2(), sqlite3_step()和sqlite3_finalize()。sqlite3_prepare_v2()編譯SQL語句生成VDBE執行碼，sqlite3_step()執行，sqlite3_finalize()關閉語句句柄，釋放資源。兩種方式，均可以經過調用sqlite3_changes(pdb)，獲得語句影響的行數。

2.3兩種方式比較
(1).sqlite3_exec方式接口使用很簡單，實現一樣的功能，比sqlite3_perpare_v2接口代碼量少。
(2).sqlite3_prepare方式更高效，由於只須要編譯一次，就能夠重複執行N次。
(3).sqlite3_prepare方式支持參數化SQL。

鑑於兩種方式的差別，對於簡單的PRAGMA設置語句(PRAGMA cache_size=2000)，事務設置語句(BEGIN TRANSACTION,COMMIT,ROLLBACK)使用sqlite3_exec方式，更簡單；而對於批量的更新、查詢語句，則使用sqlite3_prepare方式，更高效。

2.4 例子：prepare方式執行多sql的例子，pNext初始化在sql語句首部，執行完一個sql後，移動到下一個sql首部。

const char *pNext = (const char *)sql;
while (pNext && strlen(pNext) > 0) {
　　rc = sqlite3_prepare_v2(pDb, pNext, -1, &pStmt, &pNext);
　　if(SQLITE_OK != rc){
　　　　錯誤處理
　　　　break;
　　}
   
    rc = sqlite3_step(pStmt);
    if(SQLITE_OK != rc && SQLITE_DONE != rc){
　　     錯誤處理
　　     break;
    }

    rc = SQLITE_OK;

    /*統計影響記錄數目*/
    resultCount += sqlite3_changes(pDb);

    /* 清理語句句柄，準備執行下一個語句*/
    sqlite3_finalize(pStmt);
}

3.查詢SQL
3.1 sqlite3_get_table
原型：

int sqlite3_get_table(
sqlite3 *db, /* An open database */
const char *zSql, /* SQL to be evaluated */
char ***pazResult, /* Results of the query */
int *pnRow, /* Number of result rows written here */
int *pnColumn, /* Number of result columns written here */
char **pzErrmsg /* Error msg written here */
);

該函數接收SQL語句返回的全部記錄，使用sqlite內部分配的內存，將其存儲在參數resultp中，必須使用sqlite3_free_table()釋放內存。因爲結果集可能很是大，會致使內存撐爆，所以對於大結果集的查詢，不建議採用這種方式。

3.2 sqlite3_prepare_v2
prepare方式一樣支持查詢語句，主要分爲3個階段，編譯，執行和結果集處理。前面更新SQL部分已經描述了prepare的基本步驟，這裏主要講結果集處理部分。首先經過sqlite3_column_count()能夠獲得結果集的列數目，經過sqlite3_column_type()能夠獲得具體某列的存儲類型，方便咱們調用合適的sqlite3_column_xxx接口處理字段值。主要有如下幾類：
sqlite3_column_int
sqlite3_column_int64
sqlite3_column_double
sqlite3_column_text
sqlite3_column_blob

3.3 例子：遍歷結果集

int rc = sqlite3_prepare_v2(pDb, sql, -1, &pStmt, NULL);
//獲取列數目
int n_columns = sqlite3_column_count(pStmt);
do{
　　ret = sqlite3_step(stmt);
　　if (ret == SQLITE_ROW) 
　　{
　　　　//處理每一列
　　　　for (i = 0; i < n_columns; i++)
　　　　{
          /*獲取列存儲類型*/
　　　　　　type = sqlite3_column_type(stmt,i);
　　　　　　switch(type)
　　　　　　{
　　　　　　　　case SQLITE_INTEGER:
　　　　　　　　 /*處理整型*/
　　　　　　　　sqlite3_column_int(stmt,i);
　　　　　　　　break;
　　　　　　　　case SQLITE_FLOAT:
　　　　　　　　/*處理浮點數*/
　　　　　　　　sqlite3_column_double(stmt,i);
　　　　　　　　break;
　　　　　　　　case SQLITE_TEXT:
　　　　　　　　/*處理字符串*/
　　　　　　　　sqlite3_column_text(stmt,i);
              break;
　　　　　　　　case SQLITE_BLOB:
　　　　　　　　/*處理二進制*/
　　　　　　　　sqlite3_column_blob(stmt, i));
　　　　　　　  break;
　　　　　　　　case SQLITE_NULL:
　　　　　　　　/*處理空*/
　　　　　　}
　　　　}
　　}
　　else if (ret == SQLITE_DONE) //結束
　　{ 
　　　　break;
　　}
}while(true);

4.參數綁定
SQLite經過prepare接口能夠支持參數化的SQL語句，即帶問號的SQL語句。好比查詢語句select * from t where id=?，或者插入語句 insert into t(a,b,c) values(?,?,?)。經過參數化SQL，能夠實現一次編譯屢次執行的目的，因爲問號是沒有意義的，所以須要調用sqlite3_bind_xxx接口來綁定具體的參數。主要有如下幾類：
sqlite3_bind_int
sqlite3_bind_int64
sqlite3_bind_double
sqlite3_bind_text
sqlite3_bind_blob
sqlite3_bind_null
關於綁定參數這裏提一點，對於sqlite3_bind_text和sqlite3_bind_blob接口，綁定參數佔據的存儲空間是否能夠被SQLite重用。接口中經過最後一個參數指定，參數值能夠爲SQLITE_STATIC和SQLITE_TRANSIENT。

SQLITE_STATIC：通知bind函數，參數使用空間是常量，不會改變，sqlite內部無需拷貝副本。
SQLITE_TRANSIENT:通知bind函數，參數使用空間可能會改變，sqlite內部須要有本身的副本。

4.1 例子：批量導入

//begin a transaction
if(sqlite3_exec(pdb, "begin", NULL, NULL, &errmsg) != SQLITE_OK)
{
　　錯誤處理
　　return ERROR;
}

sqlite3_prepare_v2(pdb, "insert into t1 values(?,?,?);", &stmt);
for (i = 0; i < n_rows; i++)
{
　　for (j = 0; j < n_columns; j++)
　　{
　　　　switch(type)
　　　　{
　　　　　　case SQLITE_INTEGER:
　　　　　　/*處理整型*/
　　　　　　sqlite3_bind_int()
　　　　　　break;
　　　　　　case SQLITE_FLOAT:
　　　　　　/*處理浮點型*/
　　　　　　sqlite3_bind_double()
　　　　　　break;
　　　　　　case SQLITE_TEXT:
　　　　　　/*處理字符串類型*/
　　　　　　sqlite3_bind_text()
　　　　　　break;
　　　　　　case SQLITE_BLOB:
　　　　　　/*處理二進制類型*/
　　　　　　sqlite3_bind_blob
　　　　　　break;
　　　　　　case SQLITE_NULL:
　　　　　　sqlite3_bind_null(stmt, index); 
　　　　　　break;   
　　　　}    
　　}

　　sqlite3_step(stmt);  //執行
　　sqlite3_reset(stmt); //將已編譯的SQL語句恢復到初始狀態，保留語句相關的資源
}

sqlite3_finalize(stmt); //結束語句，釋放語句句柄

if(sqlite3_exec(pdb, "commit", NULL, NULL, &errmsg) != SQLITE_OK)
{
　　錯誤處理　　    return ERROR; 
}