SQLite3 C語言API入門

下載SQLite3

我們下載sqlite源碼包，只需要其中的sqlite3.c、sqlite.h即可。

最簡單的一個創建表操作

#include <stdio.h>
#include "sqlite3.h"

int main(int argc,char *argv[]){
    const char *sql_create_table="create table t(id int primary key,msg varchar(128))";
    char *errmsg = 0;
    int ret = 0;

    sqlite3 *db = 0;
    ret = sqlite3_open("./sqlite3-demo.db",&db);
    if(ret != SQLITE_OK){
        fprintf(stderr,"Cannot open db: %s\n",sqlite3_errmsg(db));
        return 1;
    }
    printf("Open database\n");

    ret = sqlite3_exec(db,sql_create_table,NULL,NULL,&errmsg);
    if(ret != SQLITE_OK){
        fprintf(stderr,"create table fail: %s\n",errmsg);
    }
    sqlite3_free(errmsg);
    sqlite3_close(db);

    printf("Close database\n");

    return 0;
}

在這個操作中我們執行了如下操作：

打開數據庫
執行SQL語句
關閉數據庫

當然這中間會有一些狀態的判斷以及內存指針的釋放等。

打開數據庫的API如下：

int sqlite3_open(
const char *filename, /* Database filename (UTF-8) */
sqlite3 **ppDb /* OUT: SQLite db handle */
);

這裏會引入一個非常複雜的sqlite3的數據結構。這個根據需要以後酌情瞭解些。

打開數據庫除了這種形式意外，還有sqlite3_open、sqlite3_open16、sqlite3_open_v2幾種形式，基本上類似。

大部分sql操作都可以通過sqlite3_exec來完成，它的API形式如下：

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 */
);

各個參數的意義爲：

sqlite3描述的是數據庫句柄
sql 要執行的SQL語句
callback回調函數
void *回調函數的第一個參數
errmsg錯誤信息，如果沒有SQL問題則值爲NULL

回調函數式一個比較複雜的函數。它的原型是這樣的:

int callback(void *params,int column_size,char **column_value,char **column_name){

每一個參數意義如下：

params是sqlite3_exec傳入的第四個參數
column_size是結果字段的個數
column_value是返回記錄的一位字符數組指針
column_name是結果字段的名稱

通常情況下callback在select操作中會使用到，尤其是處理每一行記錄數。返回的結果每一行記錄都會調用下“回調函數”。如果回調函數返回了非0，那麼sqlite3_exec將返回SQLITE_ABORT，並且之後的回調函數也不會執行，同時未執行的子查詢也不會繼續執行。

對於更新、刪除、插入等不需要回調函數的操作，sqlite3_exec的第三、第四個參數可以傳入0或者NULL。

通常情況下sqlite3_exec返回SQLITE_OK=0的結果，非0結果可以通過errmsg來獲取對應的錯誤描述。

Windows下編譯：

D:\home\dev\c>cl /nologo /TC sqlite3-demo.c sqlite3.c

GCC下編譯:

$ gcc -o sqlite3-demo.bin sqlite3-demo.c sqlite3.c

刪除表操作

爲了防止垃圾數據，我們在加載數據庫的時候刪除表操作。

簡單的刪除操作可以直接使用sqlite3_exec即可。這裏不需要回調函數以及回調函數的參數。當然需要可以關注sqlite3_exec返回的結果是否爲SQLITE_OK的值。

const char *sql_drop_table="drop table if exists t";
const char *sql_create_table="create table t(id int primary key,msg varchar(128))";

sqlite3_exec(db,sql_drop_table,0,0,&errmsg);
sqlite3_exec(db,sql_create_table,0,0,&errmsg);

插入數據

插入第一條數據

ret = sqlite3_exec(db,"insert into t(id,msg) values(1,'Ady Liu')",NULL,NULL,&errmsg);
printf("Insert a record %s\n",ret == SQLITE_OK ? "OK":"FAIL");

返回值ret爲SQLITE_OK即操作成功。

插入多條數據，並刪除數據

ret = sqlite3_exec(db,"insert into t(id,msg) values(1,'Ady Liu')",NULL,NULL,&errmsg);
    printf("Insert a record %s\n",ret == SQLITE_OK ? "OK":"FAIL");
    ret = sqlite3_exec(db,"insert into t(id,msg) values(2,'IMXYLZ')",NULL,NULL,&errmsg);
    printf("Insert a record %s\n",ret == SQLITE_OK ? "OK":"FAIL");
    ret = sqlite3_exec(db,"delete from t where id < 3",NULL,NULL,&errmsg);
    printf("Delete records: %s\n",ret == SQLITE_OK ? "OK":"FAIL");

插入多條數據，簡單的使用sqlite3_exec進行SQL執行即可。當然這裏是完整的SQL字符串。

預編譯操作

  int i = 0;
    sqlite3_stmt *stmt;
    char ca[255];

    //prepare statement
    sqlite3_prepare_v2(db,"insert into t(id,msg) values(?,?)",-1,&stmt,0);
    for(i=10;i<20;i++){
        sprintf(ca,"HELLO#%i",i);
        sqlite3_bind_int(stmt,1,i);
        sqlite3_bind_text(stmt,2,ca,strlen(ca),NULL);
        sqlite3_step(stmt);
        sqlite3_reset(stmt);
    }
    sqlite3_finalize(stmt);

預編譯操作比較麻煩的，完整的預編譯操作的流程是：

通過sqlite3_prepare_v2()創建一個sqlite3_stmt對象
通過sqlite3_bind_*()綁定預編譯字段的值
通過sqlite3_step()執行SQL語句
通過sqlite3_reset()重置預編譯語句，重複操作2多次
通過sqlite3_finalize()銷燬資源

sqlite3_prepare_v2()有個多種類似的形式，完整的API語法是：

int sqlite3_prepare(
  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 */
);

各個參數的定義爲：

db爲sqlite3的句柄
zSql爲要執行的SQL語句
nByte爲要執行語句在zSql中的最大長度，如果是負數，那麼就需要重新自動計算
ppStmt爲預編譯後的句柄
pzTail預編譯後剩下的字符串（未預編譯成功或者多餘的）的指針，通常沒什麼用，傳入0或者NULL即可。

綁定參數sqlite3_bind_*有多種形式，分別對應不同的數據類型:

int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
int sqlite3_bind_double(sqlite3_stmt*, int, double);
int sqlite3_bind_int(sqlite3_stmt*, int, int);
int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
int sqlite3_bind_null(sqlite3_stmt*, int);
int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);

預編譯SQL語句中可以包含如下幾種形式：

?
?NNN
:VVV
@VVV
$VVV

NNN代表數字，VVV代表字符串。

如果是?或者?NNN，那麼可以直接sqlite3_bind_*()進行操作，如果是字符串，還需要通過sqlite3_bind_parameter_index()獲取對應的index，然後再調用sqlite3_bind_*()操作。這通常用於構造不定條件的SQL語句（動態SQL語句）。

查詢操作

回調函數的解釋參考最上面的描述。首先聲明一個回調函數。

int print_record(void *,int,char **,char **);

查詢代碼

  //select data
    ret = sqlite3_exec(db,"select * from t",print_record,NULL,&errmsg);
    if(ret != SQLITE_OK){
        fprintf(stderr,"query SQL error: %s\n",errmsg);
    }

現在定義回調函數，只是簡單的輸出字段值。

int print_record(void *params,int n_column,char **column_value,char **column_name){
    int i;
    for(i=0;i<n_column;i++){
        printf("\t%s",column_value[i]);
    }
    printf("\n");
    return 0;
}

不使用回調的查詢操作

定義使用的變量

 char **dbresult; int j,nrow,ncolumn,index;

查詢操作

  //select table
    ret = sqlite3_get_table(db,"select * from t",&dbresult,&nrow,&ncolumn,&errmsg);
    if(ret == SQLITE_OK){
        printf("query %i records.\n",nrow);
        index=ncolumn;
        for(i=0;i<nrow;i++){
            printf("[%2i]",i);
            for(j=0;j<ncolumn;j++){
                printf(" %s",dbresult[index]);
                index++;
            }
            printf("\n");
        }
    }
    sqlite3_free_table(dbresult);

sqlite3_get_table的API語法：

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 */
);
void sqlite3_free_table(char **result);

其中：

db是sqlite3的句柄
zSql是要執行的sql語句
pazResult是執行查詢操作的返回結果集
pnRow是記錄的行數
pnColumn是記錄的字段個數
pzErrmsg是錯誤信息

由於sqlite3_get_table是sqlite3_exec的包裝，因此返回的結果和sqlite3_exec類似。

pazResult是一個(pnRow+1)*pnColumn結果集的字符串數組，其中前pnColumn個結果是字段的名稱，後pnRow行記錄是真實的字段值，如果某個字段爲空，則對應值爲NULL。

最後需要通過sqlite3_free_table()釋放完整的結果集。

更新操作

 sqlite3_exec(db,"update t set msg='MESSAGE#10' where id=10",NULL,NULL,&errmsg);

當然了，我們也可以使用預編譯方法進行更新操作。

受影響的記錄數

我們可以使用sqlite3_change(sqlite3 *)的API來統計上一次操作受影響的記錄數。

 ret = sqlite3_exec(db,"delete from t",NULL,NULL,&errmsg); 

if(ret == SQLITE_OK){

printf("delete records: %i\n",sqlite3_changes(db));

}

總結

這裏我們接觸了SQLITE3的13個API：

sqlite3_open()
sqlite3_exec()
sqlite3_close()
sqlite3_prepare_v2
sqlite3_bind_*()
sqlite3_bind_parameter_index()
sqlite3_step()
sqlite3_reset()
sqlite3_finalize()
sqlite3_get_table
sqlite3_change()
sqlite3_free()
sqlite3_free_table()

事實上截止到SQLITE3.7.14(2012/09/03) 一共提供了204個API函數（http://www.sqlite.org/c3ref/funclist.html）。

但最精簡的API函數大概有6個：

sqlite3_open()
sqlite3_prepare()
sqlite3_step()
sqlite3_column()
sqlite3_finalize()
sqlite3_close()

核心API也就10個（在精簡API基礎上增加4個）：

sqlite3_exec()
sqlite3_get_table()
sqlite3_reset()
sqlite3_bind()

因此掌握起來還是比較容易的。

bloong

發佈了8 篇原創文章 · 獲贊 9 · 訪問量 7萬+

私信關注

SQLite3 C語言API入門

下載SQLite3

最簡單的一個創建表操作

刪除表操作

插入數據

插入多條數據，並刪除數據

預編譯操作

查詢操作

不使用回調的查詢操作

更新操作

受影響的記錄數

總結

杭州的 IT 崩盤了麼？

開源高性能結構化日誌模塊NanoLog

Python 潮流週刊#55：分享 9 個高質量的技術類信息源！

Azure Virtual Network (22) 多訂閱使用Azure DNS解析問題 Windows Azure Platform 系列文章目錄

【簡寫Mybatis-02】註冊機的實現以及SqlSession處理

手繪二維碼

.NET藉助虛擬網卡實現一個簡單異地組網工具

goAhead 2.5 嵌入式web服務器移植到 ARM 板上

Android_JSON解析

GitHub詳細教程

CGIC簡明教程

將SQLite移植到ARM板上

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結