SQLite

http://blog.sina.com.cn/u/2046684565

首页博文目录关于我

个人资料

微博

加好友发纸条

写留言加关注

博客等级：
博客积分：

博客访问：
关注人气：
获赠金笔：0支
赠出金笔：0支
荣誉徽章：

正文字体大小：大中小

SQLite - API函数

(2013-04-23 21:01:46)

标签：

api函数

it

分类： Mac/IOS那些事

SQLite3 C/C++ 开发接口简介（API函数）

SQLite3是SQLite一个全新的版本,它虽然是在SQLite 2.8.13的代码基础之上开发的,但是使用了和之前的版本不兼容的数据库格式和API. SQLite3是为了满足以下的需求而开发的:

支持UTF-16编码.
用户自定义的文本排序方法.
可以对BLOBs字段建立索引.

因此为了支持这些特性我改变了数据库的格式,建立了一个与之前版本不兼容的3.0版. 至于其他的兼容性的改变,例如全新的API等等,都将在理论介绍之后向你说明,这样可以使你最快的一次性摆脱兼容性问题.

SQLite 3.0一共有83个API函数,此外还有一些数据结构和预定义(#defines). (完整的API介绍请参看另一份文档.) 不过你们可以放心,这些接口使用起来不会像它的数量所暗示的那么复杂. 最简单的程序仍然使用三个函数就可以完成: sqlite3_open(), sqlite3_exec(), 和 sqlite3_close(). 要是想更好的控制数据库引擎的执行,可以使用提供的sqlite3_prepare()函数把SQL语句编译成字节码,然后在使用sqlite3_step()函数来执行编译后的字节码. 以sqlite3_column_开头的一组API函数用来获取查询结果集中的信息. 许多接口函数都是成对出现的,同时有UTF-8和UTF-16两个版本. 并且提供了一组函数用来执行用户自定义的SQL函数和文本排序函数.

2.1 如何打开关闭数据库

   typedef struct sqlite3 sqlite3;

   int sqlite3_open(const char*, sqlite3**);

   int sqlite3_open16(const void*, sqlite3**);

   int sqlite3_close(sqlite3*);

   const char *sqlite3_errmsg(sqlite3*);

   const void *sqlite3_errmsg16(sqlite3*);

   int sqlite3_errcode(sqlite3*);

sqlite3_open() 函数返回一个整数错误代码,而不是像第二版中一样返回一个指向sqlite3结构体的指针. sqlite3_open() 和 sqlite3_open16() 的不同之处在于sqlite3_open16() 使用UTF-16编码(使用本地主机字节顺序)传递数据库文件名. 如果要创建新数据库, sqlite3_open16() 将内部文本转换为UTF-16编码, 反之sqlite3_open() 将文本转换为UTF-8编码.

打开或者创建数据库的命令会被缓存,直到这个数据库真正被调用的时候才会被执行. 而且允许使用PRAGMA声明来设置如本地文本编码或默认内存页面大小等选项和参数.

sqlite3_errcode() 通常用来获取最近调用的API接口返回的错误代码. sqlite3_errmsg() 则用来得到这些错误代码所对应的文字说明. 这些错误信息将以 UTF-8 的编码返回,并且在下一次调用任何SQLite API函数的时候被清除. sqlite3_errmsg16() 和 sqlite3_errmsg() 大体上相同,除了返回的错误信息将以 UTF-16 本机字节顺序编码.

SQLite3的错误代码相比SQLite2没有任何的改变,它们分别是:

#define SQLITE_OK           0

#define SQLITE_ERROR        1

#define SQLITE_INTERNAL     2

#define SQLITE_PERM         3

#define SQLITE_ABORT        4

#define SQLITE_BUSY         5

#define SQLITE_LOCKED       6

#define SQLITE_NOMEM        7

#define SQLITE_READONLY     8

#define SQLITE_INTERRUPT    9

#define SQLITE_IOERR       10

#define SQLITE_CORRUPT     11

#define SQLITE_NOTFOUND    12

#define SQLITE_FULL        13

#define SQLITE_CANTOPEN    14

#define SQLITE_PROTOCOL    15

#define SQLITE_EMPTY       16

#define SQLITE_SCHEMA      17

#define SQLITE_TOOBIG      18

#define SQLITE_CONSTRAINT  19

#define SQLITE_MISMATCH    20

#define SQLITE_MISUSE      21

#define SQLITE_NOLFS       22

#define SQLITE_AUTH        23

#define SQLITE_ROW         100

#define SQLITE_DONE        101

2.2 执行 SQL 语句

typedef int (*sqlite_callback)(void*,int,char**, char**);
int sqlite3_exec(sqlite3*, const char *sql, sqlite_callback, void*, char**);

sqlite3_exec 函数依然像它在SQLite2中一样承担着很多的工作. 该函数的第二个参数中可以编译和执行零个或多个SQL语句. 查询的结果返回给回调函数. 更多地信息可以查看API 参考.

在SQLite3里,sqlite3_exec一般是被准备SQL语句接口封装起来使用的.

       typedef struct sqlite3_stmt sqlite3_stmt;
       int sqlite3_prepare(sqlite3*, const char*, int, sqlite3_stmt**, const char**);
       int sqlite3_prepare16(sqlite3*, const void*, int, sqlite3_stmt**, const void**);
       int sqlite3_finalize(sqlite3_stmt*);
       int sqlite3_reset(sqlite3_stmt*);

sqlite3_prepare 接口把一条SQL语句编译成字节码留给后面的执行函数. 使用该接口访问数据库是当前比较好的的一种方法.

sqlite3_prepare() 处理的SQL语句应该是UTF-8编码的. 而sqlite3_prepare16() 则要求是UTF-16编码的. 输入的参数中只有第一个SQL语句会被编译. 第四个参数则用来指向输入参数中下一个需要编译的SQL语句存放的SQLite statement对象的指针, 任何时候如果调用 sqlite3_finalize() 将销毁一个准备好的SQL声明. 在数据库关闭之前，所有准备好的声明都必须被释放销毁. sqlite3_reset() 函数用来重置一个SQL声明的状态，使得它可以被再次执行.

SQL声明可以包含一些型如"?" 或 "?nnn" 或 ":aaa"的标记，其中"nnn" 是一个整数，"aaa" 是一个字符串. 这些标记代表一些不确定的字符值（或者说是通配符），可以在后面用sqlite3_bind 接口来填充这些值. 每一个通配符都被分配了一个编号（由它在SQL声明中的位置决定，从1开始），此外也可以用 "nnn" 来表示 "?nnn" 这种情况. 允许相同的通配符在同一个SQL声明中出现多次, 在这种情况下所有相同的通配符都会被替换成相同的值. 没有被绑定的通配符将自动取NULL值.

       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, long long int);
       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 n, void(*)(void*));
       int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);

以上是 sqlite3_bind 所包含的全部接口，它们是用来给SQL声明中的通配符赋值的. 没有绑定的通配符则被认为是空值. 绑定上的值不会被sqlite3_reset()函数重置. 但是在调用了sqlite3_reset()之后所有的通配符都可以被重新赋值.

在SQL声明准备好之后(其中绑定的步骤是可选的), 需要调用以下的方法来执行:

int sqlite3_step(sqlite3_stmt*);

如果SQL返回了一个单行结果集，sqlite3_step() 函数将返回 SQLITE_ROW , 如果SQL语句执行成功或者正常将返回 SQLITE_DONE , 否则将返回错误代码. 如果不能打开数据库文件则会返回 SQLITE_BUSY . 如果函数的返回值是 SQLITE_ROW, 那么下边的这些方法可以用来获得记录集行中的数据:

       const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
       int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
       int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
       int sqlite3_column_count(sqlite3_stmt*);
       const char *sqlite3_column_decltype(sqlite3_stmt *, int iCol);
       const void *sqlite3_column_decltype16(sqlite3_stmt *, int iCol);
       double sqlite3_column_double(sqlite3_stmt*, int iCol);
       int sqlite3_column_int(sqlite3_stmt*, int iCol);
       long long int sqlite3_column_int64(sqlite3_stmt*, int iCol);
       const char *sqlite3_column_name(sqlite3_stmt*, int iCol);
       const void *sqlite3_column_name16(sqlite3_stmt*, int iCol);
       const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
       const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
       int sqlite3_column_type(sqlite3_stmt*, int iCol);

sqlite3_column_count()函数返回结果集中包含的列数. sqlite3_column_count() 可以在执行了 sqlite3_prepare()之后的任何时刻调用. sqlite3_data_count()除了必需要在sqlite3_step()之后调用之外，其他跟sqlite3_column_count() 大同小异. 如果调用sqlite3_step() 返回值是 SQLITE_DONE 或者一个错误代码, 则此时调用sqlite3_data_count() 将返回 0 ，然而 sqlite3_column_count() 仍然会返回结果集中包含的列数.

返回的记录集通过使用其它的几个 sqlite3_column_***() 函数来提取, 所有的这些函数都把列的编号作为第二个参数. 列编号从左到右以零起始. 请注意它和之前那些从1起始的参数的不同.

sqlite3_column_type()函数返回第N列的值的数据类型. 具体的返回值如下:

       #define SQLITE_INTEGER 1
       #define SQLITE_FLOAT    2
       #define SQLITE_TEXT     3
       #define SQLITE_BLOB     4
       #define SQLITE_NULL     5

sqlite3_column_decltype() 则用来返回该列在 CREATE TABLE 语句中声明的类型. 它可以用在当返回类型是空字符串的时候. sqlite3_column_name() 返回第N列的字段名. sqlite3_column_bytes() 用来返回 UTF-8 编码的BLOBs列的字节数或者TEXT字符串的字节数. sqlite3_column_bytes16() 对于BLOBs列返回同样的结果，但是对于TEXT字符串则按 UTF-16 的编码来计算字节数. sqlite3_column_blob() 返回 BLOB 数据. sqlite3_column_text() 返回 UTF-8 编码的 TEXT 数据. sqlite3_column_text16() 返回 UTF-16 编码的 TEXT 数据. sqlite3_column_int() 以本地主机的整数格式返回一个整数值. sqlite3_column_int64() 返回一个64位的整数. 最后, sqlite3_column_double() 返回浮点数.

不一定非要按照sqlite3_column_type()接口返回的数据类型来获取数据. 数据类型不同时软件将自动转换.

2.3核心对象和接口

SQL数据库引擎的最主要任务是解析SQL语句。为了达成这个目的，开发者需要了解两个对象：

* 数据库连接对象：sqlite3

* 预处理语句对象：sqlite3_stmt

严格来讲，预处理语句对象并不是必须的，因为能够使用sqlite_exec或者sqlite3_get_table这些便于使用的封装接口，而这些接口封装并隐藏了预处理语句对象。尽管如此，对预处理对象的理解有助于我们更充分的使用SQLite。

数据库连接对象和预处理对象是由下列的一组C/C++接口调用操纵的：

* sqlite3_open()

* sqlite3_prepare()

* sqlite3_step()

* sqlite3_column()

* sqlite3_finalize()

* sqlite3_close()

这6个C/C++接口例程和上述的两个对象构成了SQLite的核心功能。开发者对于它们的理解能够更好的使用SQLite。

注意，这个接口例程列表更多是概念上的意义而不是实际的接口。许多这些接口都出现在各个版本之中。例如，上述列表中的sqlite3_open() 例程实际上有三个不同的接口以略微不同的方式实现相同的功能：slqite3_open()，sqlite3_open16()和 sqlite3_open_v2()。列表中的实际上并不存在sqlite3_column()这个接口。显示在列表中的 “sqlite3_column()”仅仅是一个占位，表示一整套用于从表中查询出各种数据类型的列记录接口。

这里说明下核心接口的主要功能：

* sqlite3_open() 该接口打开与一个SQLite数据库文件的连接并返回一个数据库连接对象。这通常是应用程序调用的第一个SQLite API接口而且也是调用其他SQLite API接口前需要调用的接口。许多SQLite接口需要一个指向数据库连接对象的指针作为它们的第一个参数，因而这些接口也可以理解成是数据库连接对象的操作接口。该接口就是创建了这样一个数据库连接对象。

* sqlite3_prepare() 该接口把一个SQL语句文本转换成一个预处理语句对象并返回一个指向该对象的指针。这个接口需要一个由先前调用sqlite3_open()返回的数据库连接对象指针以及一个预处理的SQL语句文本字符串为参数。这个API并不实际解析SQL语句，仅仅是为后续的解析而对SQL语句进行的预处理。

注意新的应用中不建议使用sqlite3_prepare()，而应该使用另一个接口sqlite3_prepare_v2()。

* sqlite3_step() 该接口用于解析一个由先前通过sqlite3_prepare()接口创建的预处理语句，直至返回第一列结果为止。通过再次调用 sqlite3_step()可以返回下一列的结果，继续不断地调用sqlite3_step()直至整个语句完成为止。对于那些并不返回结果的语句(例如：INSERT，UPDATE，DELETE语句)一次调用sqlite3_step()就完成了语句的处理。

* sqlite3_column() 该接口返回一个由sqlite3_step()解析的预处理语句结果集中当前行的某一列数据。每次执行sqlite3_step()都返回一个新的结果集中的一行。可以多次调用sqlite3_column()接口返回那一行中所有列的数据。就像上面所说的那样，SQLite API中并没有sqlite3_column()这样的接口。取而代之的是一组用于从结果集中查询出各个列项各种数据类型数据的函数接口。在这组函数接口中，有些接口返回结果集的大小，有些返回结果集的列数。

＊sqlite3_column_blob()

＊sqlite3_column_bytes()

＊sqlite3_column_bytes16()

＊sqlite3_column_count()

＊sqlite3_column_double()

＊sqlite3_column_int()

＊sqlite3_column_int64()

＊sqlite3_column_text()

＊sqlite3_column_text16()

＊sqlite3_column_type()

＊sqlite3_column_value()

* sqlite3_finalize() 该接口销毁之前调用sqlite3_prepare()创建的预处理语句。每一个预处理语句都必须调用这个接口进行销毁以避免内存泄

漏。

* sqlite3_close() 该接口关闭一个由之前调用sqlite3_open()创建的数据库连接。所有与该连接相关的预处理语句都必须在关闭连接之前销毁。

2.4扩展SQLite

SQLite包含一些可用于扩展其功能的一些其他接口，这些接口包括：

＊ sqlite3_create_collation()

＊ sqlite3_create_function()

＊ sqlite3_create_module()

sqlite3_create_collation()接口用于为索引文本创建新的对照序列。sqlite3_create_module()接口用于注册新的续表实现接口。

sqlite3_create_function()接口创建新的SQL函数-即可以是单一的也可以是组合的接口。新的函数实现通常利用下列的辅助接口：

＊ sqlite3_aggregate_context()

＊ sqlite3_result()

＊ sqlite3_user_data()

＊ sqlite3_value()

SQLite中所有内建的SQL函数接口也是通过这些相同的接口实现的。查看SQLite源代码，尤其是date.c和func.c两个文件就有许多这方面的例子。

2.5、在VC下使用SQLite

#include "../sqlite3_lib/sqlite3.h"

#pragma comment(lib, "../sqlite3_lib/sqlite3.lib")

static int _sql_callback(void * notused, int argc, char ** argv, char ** szColName)

{

int i;

for ( i=0; i < argc; i++ )

{

printf( "%s = %s/n", szColName[i], argv[i] == 0 ? "NUL" : argv[i] );

}

return 0;

}

int main(int argc, char * argv[])

{

const char * sSQL1 = "create table users(userid varchar(20) PRIMARY KEY, age int, birthday datetime);";

const char * sSQL2 = "insert into users values('wang',20,'1989-5-4');";

const char * sSQL3 = "select * from users;";

sqlite3 * db = 0;

char * pErrMsg = 0;

int ret = 0;

// 连接数据库

ret = sqlite3_open("./test.db", &db);

if ( ret != SQLITE_OK )

{

fprintf(stderr, "无法打开数据库: %s", sqlite3_errmsg(db));

return(1);

}

printf("数据库连接成功!/n");

// 执行建表SQL

sqlite3_exec( db, sSQL1, 0, 0, &pErrMsg );

if ( ret != SQLITE_OK )

{

fprintf(stderr, "SQL error: %s/n", pErrMsg);

sqlite3_free(pErrMsg);

}

// 执行插入记录SQL

sqlite3_exec( db, sSQL2, 0, 0, &pErrMsg);

// 查询数据表

sqlite3_exec( db, sSQL3, _sql_callback, 0, &pErrMsg);

// 关闭数据库

sqlite3_close(db);

db = 0;

return 0;

}

2.6 使用事务

在上面的例子中，我们向数据库里插入了10条数据，然后再从数据库里读出来。细心的你不知道有没有发现，在执行Insert的时候
，并没有使用同一个事 务。在很多情况下，我们需要使用事务来保证对数据库操作的原子性。Sqlite是支持事务的，而且对事务的使用非常简单：
使用sql语句”begin;” 表示事务开始，”rollback;”表示事务的回滚，”commit;”表示事务的提交。下面我们对上面例子中的代码作一下修改，
给Insert操作添 加事务支持：

 



bool is_succed = true;




sqlite3_exec(conn, "begin;", 0, 0, 0);  // 


开启事务

//添加10条记录

for (int i = 0; i < 10; i++)

{

    // 执行SQL

    sprintf(sql, "INSERT INTO [test_for_cpp] ([id], [name], [age]) /

        VALUES (%d, '%s', %d)", i, "JGood", i);

    if (SQLITE_OK != sqlite3_exec(conn, sql, 0, 0, &err_msg))

    {

        is_succed = false;

        break;

    }

}



if (is_succed)

    sqlite3_exec(conn, "commit;", 0, 0, 0);  // 提交事务

else

    sqlite3_exec(conn, "rollback;", 0, 0, 0);  // 回滚事务



//... ...

使用sql参数

    基本上，使用sqlite3_open, sqlite3_close, sqlite3_exec这三个函数，
可以完成大大部分的工作。但还不完善。上面的例子中，都是直接以sql语句的形式来操作数据库，这样很容易被注入。所以有必要使用sql参数。


sqlite3_prepare


sqlite3_bind_*


sqlite3_step


sqlite3_column_*


struct sqlite3_stmt


sqlite3_finalize

    sqlite3_prepare用来编译sql语句。sql语句被执行之前，
必须先编译成字节码。sqlite3_stmt是一个结构体，表示sql语句 编译后的字节码。sqlite3_step用来执行编译后的sql语句。

sqlite3_bind_*用于将sql参数绑定到sql语句。 sqlite3_column_*用于从查询的结果中获取数据。sqlite3_finalize用来释放sqlite3_stmt对象。代码最能说明函 数的功能，

下面就用一个例子来演示吧~~

// ----------------------------------------------

// http://blog.csdn.net/JGood

// sqlite3_prepare, sqlite3_bind_*, sqlite3_step, sqlite3_column_*, sqlite3_column_type

// sqlite3_stmt, sqlite3_finalize, sqlite3_reset

// 查询

// ----------------------------------------------

sqlite3 *conn = NULL;

sqlite3_stmt *stmt = NULL;

const char *err_msg = NULL;

// 列数据类型

char col_types[][10] = { "", "Integer", "Float", "Text", "Blob", "NULL" };



sqlite3_open("test.db", &conn);

sqlite3_prepare(conn, "SELECT * FROM [test_for_cpp] WHERE [id]>?", -1, &stmt, &err_msg);

sqlite3_bind_int(stmt, 1, 5);



while (SQLITE_ROW == sqlite3_step(stmt))

{

    int col_count = sqlite3_column_count(stmt); // 结果集中列的数量



    const char *col_0_name = sqlite3_column_name(stmt, 0); // 获取列名

    int id = sqlite3_column_int(stmt, 0);

    int id_type = sqlite3_column_type(stmt, 0); // 获取列数据类型



    const char *col_2_name = sqlite3_column_name(stmt, 2);

    int age = sqlite3_column_int(stmt, 2);

    int age_type = sqlite3_column_type(stmt, 2);



    const char *col_1_name = sqlite3_column_name(stmt, 1);

    char name[80];

    strncpy(name, (const char *)sqlite3_column_text(stmt, 1), 80);

    int name_type = sqlite3_column_type(stmt, 1);



    // 打印结果

    printf("col_count: %d, %s = %d(%s), %s = %s(%s), %s = %d(%s)/n",

        col_count, col_0_name, id, col_types[id_type], col_2_name, name,

        col_types[name_type], col_1_name, age, col_types[age_type]);

}



sqlite3_finalize(stmt); // 释放sqlite3_stmt 

sqlite3_close(conn);

这段代码查询id号大于5的所有记录.

其他函数

 在上面的例子中，还使用了其他的一些函数，

如：sqlite3_column_count用于获取结果集中列的数 量；sqlite3_column_name用于获取列的名称；

sqlite3_column_type用于获取列的数据类 型；sqlite3_errcode用于获取最近一次操作出错的错误代码；

sqlite3_errmsg用于获取最近一次操作出错的错误说明。 sqlite的api中还有很多的函数，有了上面的基础，

相信你通过查询官方的文档，能迅速掌握本文未介绍的api。

2.6数据库管理工具

sqlite 管理工具 Sqlite Developer

Sqlite Developer是SharpPlus出品的一款强大数据库管理软件。支持对sqlite3数据库的管理。

下载：http://dl.pconline.com.cn/download/60827.html

Sqlite Developer 注册码：http://download.csdn.net/source/2755962

VC2005 + SQLite 3.6.3 编译、测试开发

http://blog.csdn.net/Dreamcode/archive/2009/08/21/4467277.aspx

参考资料：

sqlite 中文社区：http://www.sqlite.com.cn/

sqlite 官方网站：http://www.sqlite.org/

阅读┊ 收藏 ┊ 喜欢 ▼ ┊打印┊举报/Report

前一篇：SQLite - oc连接Sqlite

后一篇：SQLite - 常见的问题集锦

新浪BLOG意见反馈留言板　欢迎批评指正