#include <db_sqlite.hpp>

类 acl::db_sqlite 继承关系图:

acl::db_sqlite 的协作图:

Public 成员函数
	db_sqlite (const char dbfile, const char charset="utf-8")

	~db_sqlite (void)

const char *	version (void) const

bool	set_conf (const char *pragma)

const char *	get_conf (const char *pragma, string &out)

void	show_conf (const char *pragma=NULL)

int	affect_total_count (void) const

sqlite3 *	get_conn (void) const

bool	prepare (sqlite_cursor &cursor)

bool	next (sqlite_cursor &cursor, bool *done)

int	sqlite3_prepare_v2 (const char zSql, int nByte, sqlite3_stmt ppStmt, const char *pzTail)

int	sqlite3_step (sqlite3_stmt *stmt)

int	sqlite3_reset (sqlite3_stmt *pStmt)

int	sqlite3_finalize (sqlite3_stmt *stmt)

int	sqlite3_bind_blob (sqlite3_stmt stmt, int iCol, const void value, int n, void(destory)(void ))

int	sqlite3_bind_int (sqlite3_stmt *stmt, int iCol, int value)

int	sqlite3_bind_int64 (sqlite3_stmt *stmt, int iCol, long long int value)

int	sqlite3_bind_text (sqlite3_stmt stmt, int iCol, const char value, int n, void(destory)(void ))

int	sqlite3_column_count (sqlite3_stmt *stmt)

const void *	sqlite3_column_blob (sqlite3_stmt *stmt, int iCol)

int	sqlite3_column_int (sqlite3_stmt *stmt, int iCol)

long long int	sqlite3_column_int64 (sqlite3_stmt *stmt, int iCol)

const unsigned char *	sqlite3_column_text (sqlite3_stmt *stmt, int iCol)

int	sqlite3_column_bytes (sqlite3_stmt *stmt, int iCol)

const char *	sqlite3_column_name (sqlite3_stmt *stmt, int iCol)

int	sqlite3_exec (const char sql, int(callback)(void , int, char , char ), void arg, char **errmsg)

void	sqlite3_free (void *ptr)

const char *	dbtype (void) const

int	get_errno (void) const

const char *	get_error (void) const

bool	dbopen (const char *charset=NULL)

bool	is_opened (void) const

bool	close (void)

bool	tbl_exists (const char *tbl_name)

bool	sql_select (const char sql, db_rows result=NULL)

bool	sql_update (const char *sql)

int	affect_count (void) const

bool	begin_transaction (void)

bool	commit (void)

bool	set_busy_timeout (int nMillisecs)

Public 成员函数继承自 acl::db_handle
	db_handle (void)

virtual	~db_handle (void)

bool	open ()

virtual bool	rollback ()

bool	exec_select (query &query, db_rows *result=NULL)

bool	exec_update (query &query)

virtual string &	escape_string (const char *in, size_t len, string &out)

const db_rows *	get_result () const

const std::vector< const db_row * > *	get_rows (const char name, const char value)

const std::vector< db_row * > *	get_rows () const

const db_row *	get_first_row () const

void	free_result ()

const db_row *	operator[] (size_t idx) const

size_t	length () const

bool	empty () const

void	print_out (size_t max=0) const

db_handle &	set_id (const char *id)

const char *	get_id () const

db_handle &	set_when (time_t now)

time_t	get_when () const

Public 成员函数继承自 acl::connect_client
	connect_client (void)

virtual	~connect_client ()

time_t	get_when ()

void	set_when (time_t when)

connect_pool *	get_pool () const

virtual void	set_timeout (int conn_timeout, int rw_timeout)

额外继承的成员函数
静态 Public 成员函数继承自 acl::db_handle
static void	set_loadpath (const char *path)

static const char *	get_loadpath ()

Protected 成员函数继承自 acl::connect_client
void	set_pool (connect_pool *pool)

Protected 成员函数继承自 acl::acl::noncopyable
	noncopyable ()

	~noncopyable ()

Protected 属性继承自 acl::db_handle
db_rows *	result_

char *	id_

time_t	when_

Protected 属性继承自 acl::connect_client
int	conn_timeout_

int	rw_timeout_

time_t	when_

connect_pool *	pool_

详细描述

在文件 db_sqlite.hpp 第 16 行定义.

构造及析构函数说明

◆ db_sqlite()

acl::db_sqlite::db_sqlite	(	const char *	dbfile,
		const char *	charset = `"utf-8"`
	)

构造函数

参数

charset {const char*} 本地字符集(gbk, utf-8, ...)

◆ ~db_sqlite()

acl::db_sqlite::~db_sqlite ( void )

成员函数说明

◆ affect_count()

int acl::db_sqlite::affect_count ( void ) const

virtual

@override

实现了 acl::db_handle.

◆ affect_total_count()

int acl::db_sqlite::affect_total_count ( void ) const

自数据库打开后所有的影响的记录行数

返回: {int} 影响的行数，-1 表示出错

◆ begin_transaction()

bool acl::db_sqlite::begin_transaction ( void )

virtual

@override

重载 acl::db_handle .

◆ close()

bool acl::db_sqlite::close ( void )

virtual

@override

实现了 acl::db_handle.

◆ commit()

bool acl::db_sqlite::commit ( void )

virtual

@override

重载 acl::db_handle .

◆ dbopen()

bool acl::db_sqlite::dbopen ( const char * charset = NULL )

virtual

@override

实现了 acl::db_handle.

◆ dbtype()

const char* acl::db_sqlite::dbtype ( void ) const

virtual

@override

实现了 acl::db_handle.

◆ get_conf()

const char* acl::db_sqlite::get_conf	(	const char *	pragma,
		string &	out
	)

当数据库打开调用此函数获得数据引擎的配置选项

参数

pragma	{const char*} 配置选项内容，格式为： PRAGMA xxx 如：PRAGMA synchronous
out	{string&} 如果返回值非空则存储结果

返回: {const char*} 为空则说明该配置不存在或数据库未打开

◆ get_conn()

sqlite3* acl::db_sqlite::get_conn ( void ) const

inline

直接获得 sqlite 的句柄，如果返回 NULL 则表示 sqlite 还没有打开或出错时内部自动关闭了 sqlite

返回: {sqlite3*}

在文件 db_sqlite.hpp 第 70 行定义.

         {
                 return db_;
         }

◆ get_errno()

int acl::db_sqlite::get_errno ( void ) const

virtual

@override

重载 acl::db_handle .

◆ get_error()

const char* acl::db_sqlite::get_error ( void ) const

virtual

@override

重载 acl::db_handle .

◆ is_opened()

bool acl::db_sqlite::is_opened ( void ) const

virtual

@override

实现了 acl::db_handle.

◆ next()

bool acl::db_sqlite::next	(	sqlite_cursor &	cursor,
		bool *	done
	)

执行下一步，如果是查询类过程，则将查询结果存入给定的参数中

参数

cursor {sqlite_cursor&}

返回: {bool}

◆ prepare()

bool acl::db_sqlite::prepare ( sqlite_cursor & cursor )

准备游标

参数

cursor {sqlite_cursor&}

返回: {bool}

◆ set_busy_timeout()

bool acl::db_sqlite::set_busy_timeout ( int nMillisecs )

@override

◆ set_conf()

bool acl::db_sqlite::set_conf ( const char * pragma )

当数据库打开后通过此函数对数据库的操作引擎进行配置，进行配置的内容需要严格遵循 sqlite 本身的配置选项要求

参数

pragma {const char*} 配置选项内容，格式为： PRAGMA xxx=xxx 如：PRAGMA synchronous = NORMAL

返回: {bool} 配置数据库是否成功

◆ show_conf()

void acl::db_sqlite::show_conf ( const char * pragma = NULL )

在数据库打开的情况下输入数据库引擎的配置选项

参数

pragma {const char*} 指定的配置选项，如果该参数为空，则输出所有的配置选项，格式为：PRAGMA xxx，如：PRAGMA synchronous

◆ sql_select()

bool acl::db_sqlite::sql_select	(	const char *	sql,
		db_rows *	result = `NULL`
	)

virtual

@override

实现了 acl::db_handle.

◆ sql_update()

bool acl::db_sqlite::sql_update ( const char * sql )

virtual

@override

实现了 acl::db_handle.

◆ sqlite3_bind_blob()

int acl::db_sqlite::sqlite3_bind_blob	(	sqlite3_stmt *	stmt,
		int	iCol,
		const void *	value,
		int	n,
		void()(void )	destory
	)

绑定二进制数据

参数

stmt	{sqlite3*} prepared statement
iCol	{int} 待绑定到sql中的参数索引
value	{const void*} 待绑定到sql中的参数数值
n	{int} 参数的字节长度
destory	{void()(void)} 传入参数的析构函数

返回: {int} 成功返回 SQLITE_OK，否则返回相应的错误代码

◆ sqlite3_bind_int()

int acl::db_sqlite::sqlite3_bind_int	(	sqlite3_stmt *	stmt,
		int	iCol,
		int	value
	)

绑定int类型数据

参数

stmt	{sqlite3*} prepared statement
iCol	{int} 待绑定到sql中的参数索引
value	{int} 待绑定到sql中的参数数值

返回: {int} 成功返回 SQLITE_OK，否则返回相应的错误代码

◆ sqlite3_bind_int64()

int acl::db_sqlite::sqlite3_bind_int64	(	sqlite3_stmt *	stmt,
		int	iCol,
		long long int	value
	)

绑定int64数据

参数

stmt	{sqlite3*} prepared statement
iCol	{int} 待绑定到sql中的参数索引
value	{long long int} 待绑定到sql中的参数数值

返回: {int} 成功返回 SQLITE_OK，否则返回相应的错误代码

◆ sqlite3_bind_text()

int acl::db_sqlite::sqlite3_bind_text	(	sqlite3_stmt *	stmt,
		int	iCol,
		const char *	value,
		int	n,
		void()(void )	destory
	)

绑定text数据

参数

stmt	{sqlite3*} prepared statement
iCol	{int} 待绑定到sql中的参数索引
value	{const void*} 待绑定到sql中的参数数值
n	{int} 参数的字节长度
destory	{void()(void)} 传入参数的析构函数

返回: {int} 成功返回 SQLITE_OK，否则返回相应的错误代码

◆ sqlite3_column_blob()

const void* acl::db_sqlite::sqlite3_column_blob	(	sqlite3_stmt *	stmt,
		int	iCol
	)

返回查询结果的对应列的二进制结果信息

参数

stmt	{sqlite3_stmt*} prepared statement
iCol	{int} 列索引

返回: {const void*} 数据指针

◆ sqlite3_column_bytes()

int acl::db_sqlite::sqlite3_column_bytes	(	sqlite3_stmt *	stmt,
		int	iCol
	)

返回查询结果的对应列的结果信息数据字节长度

参数

stmt	{sqlite3_stmt*} prepared statement
iCol	{int} 列索引

返回: {const unsigned char *} 数据指针

◆ sqlite3_column_count()

int acl::db_sqlite::sqlite3_column_count ( sqlite3_stmt * stmt )

返回 prepared statement 结果集的列数

参数

stmt	{sqlite3_stmt*} prepared statement

返回: {int} 列数量

◆ sqlite3_column_int()

int acl::db_sqlite::sqlite3_column_int	(	sqlite3_stmt *	stmt,
		int	iCol
	)

返回查询结果的对应列的int结果信息

参数

stmt	{sqlite3_stmt*} prepared statement
iCol	{int} 列索引

返回: {int} 数据

◆ sqlite3_column_int64()

long long int acl::db_sqlite::sqlite3_column_int64	(	sqlite3_stmt *	stmt,
		int	iCol
	)

返回查询结果的对应列的int64结果信息

参数

stmt	{sqlite3_stmt*} prepared statement
iCol	{int} 列索引

返回: {long long int} 数据

◆ sqlite3_column_name()

const char* acl::db_sqlite::sqlite3_column_name	(	sqlite3_stmt *	stmt,
		int	iCol
	)

返回select结果集中特定列的名称

参数

stmt	{sqlite3_stmt*} prepared statement
iCol	{int} 列索引

返回: {const char*} 列名

◆ sqlite3_column_text()

const unsigned char* acl::db_sqlite::sqlite3_column_text	(	sqlite3_stmt *	stmt,
		int	iCol
	)

返回查询结果的对应列的 utf-8 text 结果信息

参数

stmt	{sqlite3_stmt*} prepared statement
iCol	{int} 列索引

返回: {const unsigned char *} 数据指针

◆ sqlite3_exec()

int acl::db_sqlite::sqlite3_exec	(	const char *	sql,
		int()(void , int, char , char )	callback,
		void *	arg,
		char **	errmsg
	)

执行单条sql语句

参数

sql	{const char*} 待执行的sql语句
callback	{int ()(void,int,char,char)} callback函数
arg	{void*}callback函数的第一个参数
errmsg	{char**} 错误信息

返回: {int} SQLITE_OK 或其他错误码

◆ sqlite3_finalize()

int acl::db_sqlite::sqlite3_finalize ( sqlite3_stmt * stmt )

释放 prepared statement 资源

参数

stmt	{sqlite3_stmt*} prepared statement句柄

返回: {int} SQLITE_OK 或其他错误代码

◆ sqlite3_free()

void acl::db_sqlite::sqlite3_free ( void * ptr )

为释放 errmsg 而添加的接口

参数

ptr	{void*} 待释放数据指针

◆ sqlite3_prepare_v2()

int acl::db_sqlite::sqlite3_prepare_v2	(	const char *	zSql,
		int	nByte,
		sqlite3_stmt **	ppStmt,
		const char **	pzTail
	)

将zSql初始化为 prepared statement

参数

zSql	{const char*} utf-8编码的sql
nByte	{int} zSql的最大字节长度
ppStmt	{sqlite3_stmt**} OUT: prepared statement句柄
pzTail	{const char**} OUT: 指向zSql未使用部分的指针

返回: {int} 成功返回 SQLITE_OK，否则返回相应的错误代码

◆ sqlite3_reset()

int acl::db_sqlite::sqlite3_reset ( sqlite3_stmt * pStmt )

将prepared statement重置为初始化状态

参数

pStmt {sqlite3_stmt*} prepared statement

返回: {int} SQLITE_ROW, SQLITE_DONE 或 SQLITE_OK

◆ sqlite3_step()

int acl::db_sqlite::sqlite3_step ( sqlite3_stmt * stmt )

计算 prepared statement

参数

stmt	{sqlite3_stmt*} prepared statement

返回: {int} 返回 SQLITE_BUSY, SQLITE_DONE, SQLITE_ROW, SQLITE_ERROR, 或 SQLITE_MISUSE

◆ tbl_exists()

bool acl::db_sqlite::tbl_exists ( const char * tbl_name )

virtual

@override

实现了 acl::db_handle.

◆ version()

const char* acl::db_sqlite::version ( void ) const

返回当前的 sqlite 的版本信息

返回: {const char*}

该类的文档由以下文件生成:

include/acl_cpp/db/db_sqlite.hpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ db_sqlite()

◆ ~db_sqlite()

成员函数说明

◆ affect_count()

◆ affect_total_count()

◆ begin_transaction()

◆ close()

◆ commit()

◆ dbopen()

◆ dbtype()

◆ get_conf()

◆ get_conn()

◆ get_errno()

◆ get_error()

◆ is_opened()

◆ next()

◆ prepare()

◆ set_busy_timeout()

◆ set_conf()

◆ show_conf()

◆ sql_select()

◆ sql_update()

◆ sqlite3_bind_blob()

◆ sqlite3_bind_int()

◆ sqlite3_bind_int64()

◆ sqlite3_bind_text()

◆ sqlite3_column_blob()

◆ sqlite3_column_bytes()

◆ sqlite3_column_count()

◆ sqlite3_column_int()

◆ sqlite3_column_int64()

◆ sqlite3_column_name()

◆ sqlite3_column_text()

◆ sqlite3_exec()

◆ sqlite3_finalize()

◆ sqlite3_free()

◆ sqlite3_prepare_v2()

◆ sqlite3_reset()

◆ sqlite3_step()

◆ tbl_exists()

◆ version()