acl/lib_acl_cpp/include/acl_cpp/db/db_sqlite.hpp

#pragma once
#include "../acl_cpp_define.hpp"
#include "../stdlib/string.hpp"
#include "../db/db_handle.hpp"

#if !defined(ACL_DB_DISABLE)

typedef struct sqlite3 sqlite3;

namespace acl {

class charset_conv;
class sqlite_cursor;

class ACL_CPP_API db_sqlite : public db_handle
{
public:
	/**
	 * 构造函数
	 * @param charset {const char*} 本地字符集(gbk, utf-8, ...)
	 */
	db_sqlite(const char* dbfile, const char* charset = "utf-8");
	~db_sqlite(void);

	/**
	 * 返回当前的 sqlite 的版本信息
	 */
	const char* version(void) const;

	/**
	 * 当数据库打开后通过此函数对数据库的操作引擎进行配置，
	 * 进行配置的内容需要严格遵循 sqlite 本身的配置选项要求
	 * @param pragma {const char*} 配置选项内容，格式为：
	 *  PRAGMA xxx=xxx
	 *  如：PRAGMA synchronous = NORMAL
	 * @return {bool} 配置数据库是否成功
	 */
	bool set_conf(const char* pragma);

	/**
	 * 当数据库打开调用此函数获得数据引擎的配置选项
	 * @param pragma {const char*} 配置选项内容，格式为：
	 *  PRAGMA xxx
	 *  如：PRAGMA synchronous
	 * @param out {string&} 如果返回值非空则存储结果
	 * @return {const char*} 为空则说明该配置不存在或数据库未打开
	 */
	const char* get_conf(const char* pragma, string& out);

	/**
	 * 在数据库打开的情况下输入数据库引擎的配置选项
	 * @param pragma {const char*} 指定的配置选项，如果该参数为空，
	 *  则输出所有的配置选项，格式为：PRAGMA xxx，如：PRAGMA synchronous
	 */
	void show_conf(const char* pragma = NULL);

	/**
	 * 自数据库打开后所有的影响的记录行数
	 * @return {int} 影响的行数，-1 表示出错
	 */
	int affect_total_count(void) const;

	/**
	 * 直接获得 sqlite 的句柄，如果返回 NULL 则表示 sqlite 还没有打开
	 * 或出错时内部自动关闭了 sqlite
	 * @return {sqlite3*}
	 */
	sqlite3* get_conn(void) const
	{
		return db_;
	}

	/**
	 * 准备游标
	 * @param cursor {sqlite_cursor&}
	 * @return {bool}
	 */
	bool prepare(sqlite_cursor& cursor);

	/**
	 * 执行下一步，如果是查询类过程，则将查询结果存入给定的参数中
	 * @param cursor {sqlite_cursor&}
	 * @return {bool}
	 */
	bool next(sqlite_cursor& cursor, bool* done);

	/********************************************************************/
	/*            以下为基类 db_handle 的虚接口                         */
	/********************************************************************/

	/**
	 * @override
	 */
	const char* dbtype(void) const;

	/**
	 * @override
	 */
	int get_errno(void) const;

	/**
	 * @override
	 */
	const char* get_error(void) const;

	/**
	 * @override
	 */
	bool dbopen(const char* charset = NULL);

	/**
	 * @override
	 */
	bool is_opened(void) const;

	/**
	 * @override
	 */
	bool close(void);

	/**
	 * @override
	 */
	bool tbl_exists(const char* tbl_name);

	/**
	 * @override
	 */
	bool sql_select(const char* sql, db_rows* result = NULL);

	/**
	 * @override
	 */
	bool sql_update(const char* sql);

	/**
	 * @override
	 */
	int affect_count(void) const;

	/**
	 * @override
	 */
	bool begin_transaction(void);

	/**
	 * @override
	 */
	bool commit(void);

	/**
	 * @override
	 */
	bool set_busy_timeout(int nMillisecs);

private:
	// sqlite 引擎
	sqlite3* db_;

	// 数据存储文件
	string dbfile_;

	// 字符集转码器
	charset_conv* conv_;

	// 本地字符集
	string charset_;

	// 真正执行SQL查询的函数
	bool exec_sql(const char* sql, db_rows* result = NULL);
};

} // namespace acl

#endif // !defined(ACL_DB_DISABLE)