Skip to main content

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을 추가할 계획입니다. :-)

Comments

  1. 정말 좋은 wrapper 라이브러리네요 ㅎㅇㅎ;

    잘 쓸께요 ㅎㅇㅎㅋ

    ReplyDelete
  2. 매우 깔끔하네요.
    이것저것 찾아다니가가 SQLite라는 걸 알게 됐는데...
    지금은 Sqlite3pp를 사용하진 않지만 나중에 꼭 공부해보고 싶네요.

    소스 공개 감사드려요^^~

    ReplyDelete
  3. Sometimes you need to change parameters in select clauses as well.

    Like so:

    "select * from blah where id between ? and ?"

    How would you do that in sqlite3pp?

    ReplyDelete

Post a Comment

Popular posts from this blog

1의 개수 세기 - 해답

벌써 어제 말한 내일이 되었는데 답을 주신 분이 아무도 없어서 좀 뻘쭘하네요. :-P 그리고 어제 문제에 O(1)이라고 적었는데 엄밀히 얘기하자면 O(log 10 n)이라고 적었어야 했네요. 죄송합니다. ... 문제를 잠시 생각해보면 1~n까지의 수들 중 1의 개수를 얻기 위해서는 해당 숫자 n의 각 자리의 1의 개수가 모두 몇개나 될지를 구해서 더하면 된다는 사실을 알 수 있습니다. 예를 들어 13이라는 수를 생각해 보면 1~13까지의 수에서 1의 자리에는 1이 모두 몇개나 되는지와 10의 자리에는 모두 몇개나 되는지를 구해 이 값을 더하면 됩니다. 먼저 1의 자리를 생각해 보면 1, 11의 두 개가 있으며 10의 자리의 경우, 10, 11, 12, 13의 네 개가 있습니다. 따라서 2+4=6이라는 값을 구할 수 있습니다. 이번엔 234라는 수에서 10의 자리를 예로 들어 살펴 보겠습니다. 1~234라는 수들 중 10의 자리에 1이 들어가는 수는 10, 11, ..., 19, 110, 111, ... 119, 210, 211, ..., 219들로 모두 30개가 있음을 알 수 있습니다. 이 규칙들을 보면 해당 자리수의 1의 개수를 구하는 공식을 만들 수 있습니다. 234의 10의 자리에 해당하는 1의 개수는 ((234/100)+1)*10이 됩니다. 여기서 +1은 해당 자리수의 수가 0이 아닌 경우에만 더해집니다. 예를 들어 204라면 ((204/100)+0)*10으로 30개가 아닌 20개가 됩니다. 이런 방식으로 234의 각 자리수의 1의 개수를 구하면 1의 자리에 해당하는 1의 개수는 ((234/10)+1)*1=24개가 되고 100의 자리에 해당하는 개수는 ((234/1000)+1)*100=100이 됩니다. 이들 세 수를 모두 합하면 24+30+100=154개가 됩니다. 한가지 추가로 생각해야 할 점은 제일 큰 자리의 수가 1인 경우 위의 공식이 아닌 다른 공식이 필요하다는 점입니다. 예를 들어 123에서 100의 자리에 해당하는 1의 개수는 ((123/1

std::map에 insert하기

얼마전 회사 동료가 refactoring한 코드를 열심히 revert하고 있어서 물어보니 다음과 같은 문제였습니다. 원래 코드와 refactoring한 코드는 다음과 같더군요. nvp[name] = value; // original code nvp.insert(make_pair(name, value)); // refactored 아시겠지만 위의 두 라인은 전혀 다른 기능을 하죠. C++03에 보면 각각 다음과 같이 설명되어 있습니다. 23.1.2/7 Associative containers a_uniq.insert(t): pair<iterator, bool> inserts t if and only if there is no element in the container with key equivalent to the key of t. The bool component of the returned pair indicates whether the insertion takes place and the iterator component of the pair points to the element with key equivalent to the key of t. 23.3.1.2/1 map element access [lib.map.access] T& operator[](const key_type& x); Returns: (*((insert(make_pair(x, T()))).first)).second. 원래 코드는 매번 새 값으로 이전 값을 overwrite했지만 새 코드는 이전에 키가 존재하면 새값으로 overwrite하지 않습니다. 따라서 원래 기능이 제대로 동작하지 않게 된것이죠. 그래서 물어봤죠. "왜 이렇게 했어?" "insert가 성능이 더 좋다 그래서 했지." :-? 사실 Fowler 아저씨는 Refactoring 책에서 refactoring은 성능을 optimizing하기 위한 것이 아니다라

C++ of the Day #9 - Boost.Python 사용하기 #1

Python 은 가장 인기있는 interpret 언어중의 하나입니다. Python의 장점 중 하나는 C/C++ 모듈과 쉽게 연동할 수 있다는 점입니다. 물론 손으로 일일히 wrapper를 만드는 것은 손이 많이 가고 에러를 만들수 있는 작업이나 SWIG 등과 같은 도구를 사용하면 쉽게 python 모듈을 만들 수 있습니다. Boost.Python 은 이런 SWIG와 같이 python 모듈을 쉽게 만들 수 있도록 도와주는 라이브러리로 순수 C++만을 사용한다는 점이 SWIG와 다른 점입니다. 그리고 개인적으로는 Boost 라이브러리에 포함되어 있는 것들이 왠지 좀 더 믿음직스러워서... :-) 이번 글에서는 Boost.Python 문서에 나와 있는 예제 를 가지고 간단하게 python 모듈을 만드는 방법에 대해서 알아보겠습니다. Requirements 리눅스 이 글에서는 리눅스 환경에서의 사용 방법을 설명한다. Boost.Python 라이브러리 (1.33.1) Boost 라이브러리를 다운로드받아 아래와 유사한 명령으로 라이브러리를 빌드한다. bjam -sTOOLS=gcc -with-python install bjam의 --prefix 옵션으로 라이브러리가 설치될 위치를 변경할 수 있다. Python 라이브러리 (2.4.3) Python을 다운로드 받아 빌드하여 설치한다. 위의 경우와 유사하게 configure의 --prefix 옵션으로 설치될 위치를 변경할 수 있다. Write C++ Code 다음과 같이 코드를 작성한다. // greet.cpp #include <stdexcept> char const* greet(unsigned x) { static char const* const msgs[] = { "hello", "Boost.Python", "world!" }; if (x > 2) throw std::range_error("