C++ of the Day #43 - SQLite3 C++ wrapper #1

The Definitive Guide to SQLite를 읽다가 공부 겸 해서 C++ wrapper를 만들어 보았습니다. 최대한 C++ 냄새(?)가 나도록 만들어 보았습니다. :-) ((SQLite는 복잡한 관리가 필요없이 사용가능한, 파일이나 메모리 기반의, 라이브러리로 제공되는, 약 250kb 용량의, 대부분의 SQL92문을 지원하는, open source RDB입니다.))
이 wrapper를 사용하기 위해서는 (당연하게도!) sqlite3와 (당연하게도?) boost 라이브러리가 필요합니다.
사용 예들을 살펴보는 것으로 설명을 대신합니다.
이번 글에서는 다음과 같은 contacts 테이블이 test.db에 존재한다고 가정합니다.

CREATE TABLE contacts
(
id INTEGER PRIMARY KEY,
name TEXT NOT NULL,
phone TEXT NOT NULL,
UNIQUE(name, phone)
);

Command

먼저 test.db 파일을 사용하기 위해 다음과 같이 파일 이름을 주어 connection 객체를 생성합니다. 생성과 동시에 test.db와 연결이 이루어집니다. ((생성자외에 open() 함수를 사용할 수도 있습니다.))

sqlite3pp::connection conn("test.db");

다음은 contacts 테이블에 정보를 추가하는 가장 간단한 방법입니다. connection 클래스에서 제공하는 execute 함수를 사용합니다. ((executef 함수를 사용하면 printf와 같은 문법을 사용하여 query문을 작성할 수 있습니다.))

conn.execute("INSERT INTO contacts (name, phone) VALUES ('user', '1234')");

위와 동일한 작업을 parameterized query를 사용하여 할 수도 있습니다. ((step()함수가 실제 query문을 수행하는 함수입니다. run()과 같은 이름을 사용할까 했으나 sqlite에서 사용하는 이름을 그대로 사용하기로 하였습니다.))

sqlite3pp::command cmd(conn, "INSERT INTO contacts (name, phone) VALUES (?, ?)");
cmd.bind(1, "user");
cmd.bind(2, "1234");
cmd.step();
// or
sqlite3pp::command cmd(conn, "INSERT INTO contacts (name, phone) VALUES (:name, :phone)");
cmd.bind(":name", "user");
cmd.bind(":phone", "1234");
cmd.step();

같은 query문(command 객체)을 재사용하려면 cmd.reset() 함수 호출후에 원하는 필드만 다른 값으로 binding하여 다시 step() 함수를 호출하면 됩니다.
위의 코드 중 두 줄로 된 binding 작업은 다음과 같이 left shift operator를 사용하여 한 줄로 작성이 가능합니다.

cmd.binder() << "user" << "1234";

Query

이제 select를 사용하여 데이터를 읽는 방법에 대해서 알아보도록 하겠습니다. 이 경우 command 클래스 대신 query 클래스를 사용합니다. ((query 클래스는 command 클래스를 상속받은 클래스로 record fetch 에 필요한 함수나 클래스, iterator등을 추가로 제공합니다.))

sqlite3pp::connection conn("test.db");

sqlite3pp::query qry(conn, "SELECT id, phone, name FROM contacts");

먼저 column name을 가지고 헤더를 출력하려면 다음과 같이 column_name() 함수를 사용합니다.

for (int i = 0; i < qry.column_count(); ++i) {
cout << qry.column_name(i) << "\t";
}

다음으로 한 record씩 읽어오기 위해 query 클래스가 제공하는 iterator를 사용합니다. 각 record에서 column의 값을 읽어오는 방법에는 몇 가지가 있는데 하나씩 살펴보죠. 먼저 각 column의 타입을 모른다면 다음과 같이 무조건 char const* 타입으로 받아 출력하는 방법을 사용할 수 있습니다. ((char const* 타입 대신 std::string 타입을 사용할 수도 있습니다. 하지만 std::string 타입을 사용할 경우 sqlite 내부 버퍼에 있는 text 데이터가 std::string 객체로 복사되는 비용이 추가로 발생합니다.))

for (sqlite3pp::query::iterator i = qry.begin(); i != qry.end(); ++i) {
for (int j = 0; j < qry.column_count(); ++j) {
cout << (*i).get(j) << "\t"; // type conversion is done by sqlite
}
cout << endl;
}

다음으로 각 column의 타입을 알고 있다면 right shift operator 문법을 사용할 수 있습니다.

int id;
std::string name, phone;

for (sqlite3pp::query::iterator i = qry.begin(); i != qry.end(); ++i) {
(*i).getter() >> id >> name >> phone;
cout << id << "\t" << name << "\t" << phone << endl;
}

마지막으로 boost::tuple을 사용하는 방법도 제공합니다.

for (sqlite3pp::query::iterator i = qry.begin(); i != qry.end(); ++i) {
boost::tie(id, name, phone) =
(*i).get_columns(0, 1, 2);
cout << id << "\t" << name << "\t" << phone << endl;
}

boost::tuple을 사용하면 원하는 column들을 쉽게 선택할 수 있다는 장점이 있습니다. 예를 들어 위의 코드에서 name과 phone 정보만 필요하다면 다음과 같이 할 수 있습니다.

boost::tie(name, phone) = (*i).get_columns(1, 2);
// now, int type and 0 index are dropped.

물론 right shift operator를 사용하는 방법에도 원하는 column만을 선택할 수 있는 방법이 있습니다. 원하지 않는 column의 자리에 sqlite3pp::ignore를 사용하면 됩니다.

(*i).getter() >> sqlite3pp::ignore >> name >> phone; // id value is not fetched at all.

Transaction

위에 있는 모든 query문들은 autocommit 모드로 동작을 합니다. 한 구문이 한번씩 commit을 사용하는 것이죠. 여러개의 구문을 하나의 transaction으로 묶기 위해서는 transaction 객체를 사용합니다.

{
sqlite3pp::transaction xct(conn); // begin transaction with default rollback option.

sqlite3pp::command cmd(conn, "INSERT INTO contacts (name, phone) VALUES (?, ?)");

cmd.binder() << "user" << "1234";
if (SQLITE_DONE != cmd.step())
return; // end transaction with rollback

cmd.reset(); // reuse cmd object.

cmd.binder() << "user" << "5678";
if (SQLITE_DONE != cmd.step())
return; // end transaction with rollback

xct.commit(); // end transaction with commit
}

transaction 객체는 RAII를 사용하여 destructor에서 commit 모드에 따라 commit이나 rollback을 하게 됩니다. 물론 명시적으로 commit이나 rollback이 호출된 경우에는 destructor에서 아무 동작도 하지 않습니다. 위의 코드는 기본 모드로 rollback을 사용하고 있으나 다음과 같이 commit을 기본 모드로 설정할 수 있습니다.

sqlite3pp::transaction xct(conn, true);

Download

현재까지 작성한 코드로 위에 나온 내용들은 모두 구현되어 있습니다. Sqlite3pp.zip 앞으로 sqlite3의 extension과 callback 인터페이스들에 대한 C++ wrapping을 추가할 계획입니다. :-)