/qtl

A friendly and lightweight C++ database library for MySQL, SQLite and ODBC.

Primary LanguageC++Apache License 2.0Apache-2.0

QTL

QTL是一个访问SQL数据库的C++库，目前支持MySQL、SQLite和ODBC。QTL是一个轻量级的库，只由头文件组成，不需要单独编译安装。QTL是对数据库原生客户端接口的薄封装，能提供友好使用方式的同时拥有接近于使用原生接口的性能。 使用QTL需要支持C++11的编译器。

使用方式

打开数据库

qtl::mysql::database db;
db.open("localhost", "root", "", "test");

执行查询

1. 插入记录

uint64_t id=db.insert("insert into test(Name, CreateTime) values(?, now())", "test_user");

2. 更新记录

db.execute_direct("update test set Name=? WHERE ID=?",  NULL, "other_user", id);

3. 更新多条记录：

uint64_t affected=0;
auto stmt=db.open_command("insert into test(Name, CreateTime) values(?, now())");
qtl::execute(stmt, &affected, "second_user", "third_user");

或者

stmt<<"second_user"<<"third_user";

4. 查询数据，以回调函数方式处理数据

程序会一直遍历数据集，直到当回调函数返回false为止。如果回调函数无返回值，相当于返回true。

db.query("select * from test where id=?", id, 
	[](uint32_t id, const std::string& name, const qtl::mysql::time& create_time) {
		printf("ID=\"%d\", Name=\"%s\"\n", id, name.data());
});

当无法根据回调函数的参数推断字段类型时，请使用query_explicit代替query，手动指定数据类型进行查询。

5. 也可以把数据绑定到结构上

struct TestMysqlRecord
{
	uint32_t id;
	char name[33];
	qtl::mysql::time create_time;

	TestMysqlRecord()
	{
		memset(this, 0, sizeof(TestMysqlRecord));
	}
};

namespace qtl
{
	template<>
	inline void bind_record<qtl::mysql::statement, TestMysqlRecord>(qtl::mysql::statement& command, TestMysqlRecord&& v)
	{
		qtl::bind_field(command, 0, v.id);
		qtl::bind_field(command, 1, v.name);
		qtl::bind_field(command, 2, v.create_time);
	}
}

db.query("select * from test where id=?", id, 
	[](const TestMysqlRecord& record) {
		printf("ID=\"%d\", Name=\"%s\"\n", record.id, record.name);
});

6. 用成员函数做为查询的回调函数

当记录类有不带参数的成员函数时，可以直接用作查询的回调函数

struct TestMysqlRecord
{
	void print();
};

db.query("select * from test where id=?", id,
	&TestMysqlRecord::print);

7. 以迭代器方式访问数据

for(auto& record : db.result<TestMysqlRecord>("select * from test"))
{
	printf("ID=\"%d\", Name=\"%s\"\n", record.id, record.name);
}

8. 指示器

可以用指示器获取查询结果的更多信息。指示器包含以下成员：

  • data 存储字段的数据
  • is_null 字段是否为空
  • length 数据的实际长度
  • is_truncated 数据是否被截断

9. 支持标准库以外的字符串类型

除了标准库提供的std::string，另外其他库也提供了自己的字符串类，比如QT的QString，MFC/ATL的CString等。qtl也可以将字符字段绑定到这些类型上。扩展方法是：

  1. 为你的字符串类型，对 qtl::bind_string_helper 实现一个专门化。如果该字符串类型有符合标准库字符串语义的以下成员函数，可以跳过这一步：assign，clear，resize，data，size；
  2. 为你的字符串类型，对 qtl::bind_field 实现一个专门化；

因为QT的QString有兼容标准库的成员函数，所以绑定到QString只需要一步：

namespace qtl
{
	template<typename Command>
	inline void bind_field(Command& command, size_t index, QString&& value)
	{
		command.bind_field(index, bind_string(std::forward<QString>(value)));
	}
}

10.处理返回多个结果集的查询

有些查询语句会返回多个结果集。使用函数query执行这些查询只能得到第一个结果集。要处理所有结果集需要使用query_multi或query_multi_with_params。query_multi不会为没有结果集的查询调用回调函数。例如：

CREATE PROCEDURE test_proc()
BEGIN
	select 0, 'hello world' from dual;
	select now() from dual;
END
db.query_multi("call test_proc", 
	[](uint32_t i, const std::string& str) {
		printf("0=\"%d\", 'hello world'=\"%s\"\n", i, str.data());
}, [](const qtl::mysql::time& time) {
	struct tm tm;
	time.as_tm(tm);
	printf("current time is: %s\n", asctime(&tm));
});

有关MySQL的说明

访问MySQL时，包含头文件qtl_mysql.hpp。

MySQL的参数数据绑定

参数类型 C++类型
tinyint int8_t
uint8_t
smallint int16_t
uint16_t
int int32_t
uint32_t
bigint int64_t
uint64_t
float float
double double
char
varchar		 const char*
std::string
blob
binary
text		 qtl::const_blob_data
std::istream
date
time
datetime
timestamp		 qtl::mysql::time

MySQL的字段数据绑定

字段类型 C++类型
tinyint int8_t
uint8_t
smallint int16_t
uint16_t
int int32_t
uint32_t
bigint int64_t
uint64_t
float float
double double
char
varchar		 char[N]
std::array<char, N>
std::string
blob
binary
text		 qtl::blob_data
std::ostream
date
time
datetime
timestamp		 qtl::mysql::time

MySQL相关的C++类

  • qtl::mysql::database 表示一个MySQL的数据库连接，程序主要通过这个类操纵数据库。
  • qtl::mysql::statement 表示一个MySQL的查询语句，实现查询相关操作。
  • qtl::mysql::error 表示一个MySQL的错误，当操作出错时，抛出该类型的异常，包含错误信息。
  • qtl::mysql::transaction 表示一个MySQL的事务操作。
  • qtl::mysql::query_result 表示一个MySQL的查询结果集，用于以迭代器方式遍历查询结果。

有关SQLite的说明

访问SQLite时，包含头文件qtl_sqlite.hpp。

SQLite的参数数据绑定

参数类型 C++类型
integer int
int64_t
real double
text const char*
std::string
std::wstring
blob qtl::const_blob_data

SQLite的字段数据绑定

字段类型 C++类型
integer int
int64_t
real double
text char[N]
std::array<char, N>
std::string
std::wstring
blob qtl::const_blob_data
qtl::blob_data
std::ostream

当以qtl::const_blob_data接收blob数据时，直接返回SQLite给出的数据地址；当以qtl::blob_data接收blob数据时，数据被复制到qtl::blob_data指定的地址。

SQLite相关的C++类

  • qtl::sqlite::database 表示一个SQLite的数据库连接，程序主要通过这个类操纵数据库。
  • qtl::sqlite::statement 表示一个SQLite的查询语句，实现查询相关操作。
  • qtl::sqlite::error 表示一个SQLite的错误，当操作出错时，抛出该类型的异常，包含错误信息。
  • qtl::sqlite::transaction 表示一个SQLite的事务操作。
  • qtl::sqlite::query_result 表示一个SQLite的查询结果集，用于以迭代器方式遍历查询结果。

有关ODBC的说明

通过ODBC访问数据库时，包含头文件qtl_odbc.hpp。 QTL不支持ODBC的输出参数。

ODBC的参数数据绑定

参数类型 C++类型
TINYINT int8_t
uint8_t
SMALLINT int16_t
uint16_t
INTEGER int32_t
uint32_t
BIGINT int64_t
uint64_t
FLOAT float
DOUBLE double
NUMERIC SQL_NUMERIC_STRUCT
BIT bool
CHAR
VARCHAR		 const char*
std::string
WCHAR
WVARCHAR		 const wchar_t*
std::wstring
BINARY qtl::const_blob_data
LONGVARBINARY std::istream
DATE qtl::odbc::date
TIME
UTCTIME		 qtl::odbc::time
TIMESTAMP
UTCDATETIME		 qtl::odbc::datetime
GUID SQLGUID

ODBC的字段数据绑定

字段类型 C++类型
TINYINT int8_t
uint8_t
SMALLINT int16_t
uint16_t
INTEGER int32_t
uint32_t
BIGINT int64_t
uint64_t
FLOAT float
DOUBLE double
NUMERIC SQL_NUMERIC_STRUCT
BIT bool
CHAR
VARCHAR		 char[N]
std::array<char, N>
std::string
WCHAR
WVARCHAR		 wchar_t[N]
std::array<wchar_t, N>
std::string
BINARY qtl::blob_data
LONGVARBINARY std::ostream
DATE qtl::odbc::date
TIME
UTCTIME		 qtl::odbc::time
TIMESTAMP
UTCDATETIME		 qtl::odbc::datetime
GUID SQLGUID

ODBC相关的C++类

  • qtl::odbc::database 表示一个ODBC的数据库连接，程序主要通过这个类操纵数据库。
  • qtl::odbc::statement 表示一个ODBC的查询语句，实现查询相关操作。
  • qtl::odbc::error 表示一个ODBC的错误，当操作出错时，抛出该类型的异常，包含错误信息。
  • qtl::odbc::transaction 表示一个ODBC的事务操作。
  • qtl::odbc::query_result 表示一个ODBC的查询结果集，用于以迭代器方式遍历查询结果。

关于测试

编译测试用例的第三方库需要另外下载。除了数据库相关的库外，测试用例用到了测试框架CppTest。

测试用例所用的MySQL数据库如下：

CREATE TABLE test (
  ID int NOT NULL AUTO_INCREMENT,
  Name varchar(32) NOT NULL,
  CreateTime timestamp NOT NULL DEFAULT '0000-00-00 00:00:00' ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (ID)
);

CREATE TABLE test_blob (
  ID int unsigned NOT NULL AUTO_INCREMENT,
  Filename varchar(255) NOT NULL,
  Content longblob,
  MD5 binary(16) DEFAULT NULL,
  PRIMARY KEY (ID)
);

测试用例在 Visual Studio 2013 和 GCC 4.8 下测试通过。