SQLite: сохранение и загрузка БД из памяти в файл и из файла в память
Материал из Wiki.crossplatform.ru
Содержание |
Краткое введение
SQLite представляет из себя довольно простой движок для организации локальной базы данных. Обычный сценарий использования SQLite — работа с базой данных в рамках одной программы.
База данных SQLite может быть расположена в двух местах:
- в файле (в таком случае имя базы данных является путём к файлу)
- в памяти (в таком случае имя базы данных должно быть ":memory:")
Если с файлом управиться довольно просто (его можно скопировать, удалить и т.п.), то с БД в памяти всё не столь очевидно.
Для того, чтобы скопировать БД из памяти в файл, либо наоборот, из файла в память, разработчики SQLite рекомендуют использовать механизм резервирования "On-line Backup" (в данном случае под on-line подразумевается "горячее" копирование без блокировки БД).
Сохранение/загрузка через резервирование (в Qt)
Для того, чтобы сохранить/загрузить БД из памяти / в память через функцию резервирования, необходимо сделать два действия:
- подключить SQLite API к проекту
- добавить в код функцию резервирования БД
Подключение SQLite API
Рассмотрим вариант статического подключения SQLite, как наиболее простой. SQLite является общественным достоянием, поэтому лицензионных ограничений по линковке здесь нет.
Сначала необходимо добавить в .pro файл (ваш проект) следующие строки:
INCLUDEPATH = $$[QT_INSTALL_PREFIX]/src/3rdparty/sqlite SOURCES += $$[QT_INSTALL_PREFIX]/src/3rdparty/sqlite/sqlite3.c
Примечания:
- С помощью INCLUDEPATH мы добавляем файл sqlite3.h в общее пространство подключаемых заголовков. Это нужно, например, чтобы Qt-Creator правильно понимал команды SQLite API.
- С помощью SOURCES мы банально добавляем файл sqlite3.c в наш проект на ровне с другими .с файлами. Таким образом, мы сообщаем Qt о том, что этот файл необходимо откомпилировать. Без этого, проект не соберётся на этапе линковки (в Qt-Creator вы получите ошибки, связанные с ld).
- Параметр $$[QT_INSTALL_PREFIX] всегда указывает путь установки Qt. Дополнительно о параметрах qmake можно ознакомиться в соседнем разделе wiki.
Далее необходимо просто подключить заголовок sqlite3.h в код, где будем использовать резервирование. Заголовок можно указать в угловых скобках, так как он всё-равно будет найден через INCLUDEPATH.
#include <sqlite3.h>
На этом SQLite API подключен.
Функция сохранения/загрузки БД
Из примера по резервированию видно, что SQLite API требует соединения с БД в своём формате (sqlite3*), а у нас в Qt используется иной класс: QSqlDatabase().
К счастью, разработчики Qt позаботились о возможности получить нативное (для различных SQL API) соединение. Для этого используется функция:QVariant QSqlDriver::handle();
С примером получения хендлера для SQLite можно ознакомиться в справке Qt по классу QSqlDriver.
Получив хэндлер соединения в SQLite API можно спокойно использовать функцию резервирования. Для удобства, можно написать единую функцию для резервирования, которая в качестве входных параметров получает привычные нам QSqlDatabase и QString:
/* ** This function is used to load the contents of a database file on disk ** into the "main" database of open database connection pInMemory, or ** to save the current contents of the database opened by pInMemory into ** a database file on disk. pInMemory is probably an in-memory database, ** but this function will also work fine if it is not. ** ** Parameter zFilename points to a nul-terminated string containing the ** name of the database file on disk to load from or save to. If parameter ** isSave is non-zero, then the contents of the file zFilename are ** overwritten with the contents of the database opened by pInMemory. If ** parameter isSave is zero, then the contents of the database opened by ** pInMemory are replaced by data loaded from the file zFilename. ** ** If the operation is successful, SQLITE_OK is returned. Otherwise, if ** an error occurs, an SQLite error code is returned. */ bool sqliteDBMemFile( QSqlDatabase memdb, QString filename, bool save ) { bool state = false; QVariant v = memdb.driver()->handle(); if( v.isValid() && qstrcmp(v.typeName(),"sqlite3*") == 0 ) { // v.data() returns a pointer to the handle sqlite3 * handle = *static_cast<sqlite3 **>(v.data()); if( handle != 0 ) // check that it is not NULL { sqlite3 * pInMemory = handle; const char * zFilename = filename.toLocal8Bit().data(); int rc; /* Function return code */ sqlite3 *pFile; /* Database connection opened on zFilename */ sqlite3_backup *pBackup; /* Backup object used to copy data */ sqlite3 *pTo; /* Database to copy to (pFile or pInMemory) */ sqlite3 *pFrom; /* Database to copy from (pFile or pInMemory) */ /* Open the database file identified by zFilename. Exit early if this fails ** for any reason. */ rc = sqlite3_open( zFilename, &pFile ); if( rc==SQLITE_OK ){ /* If this is a 'load' operation (isSave==0), then data is copied ** from the database file just opened to database pInMemory. ** Otherwise, if this is a 'save' operation (isSave==1), then data ** is copied from pInMemory to pFile. Set the variables pFrom and ** pTo accordingly. */ pFrom = ( save ? pInMemory : pFile); pTo = ( save ? pFile : pInMemory); /* Set up the backup procedure to copy from the "main" database of ** connection pFile to the main database of connection pInMemory. ** If something goes wrong, pBackup will be set to NULL and an error ** code and message left in connection pTo. ** ** If the backup object is successfully created, call backup_step() ** to copy data from pFile to pInMemory. Then call backup_finish() ** to release resources associated with the pBackup object. If an ** error occurred, then an error code and message will be left in ** connection pTo. If no error occurred, then the error code belonging ** to pTo is set to SQLITE_OK. */ pBackup = sqlite3_backup_init(pTo, "main", pFrom, "main"); if( pBackup ){ (void)sqlite3_backup_step(pBackup, -1); (void)sqlite3_backup_finish(pBackup); } rc = sqlite3_errcode(pTo); } /* Close the database connection opened on database file zFilename ** and return the result of this function. */ (void)sqlite3_close(pFile); if( rc == SQLITE_OK ) state = true; } } return state; }
Обсуждение
Обсудить статью, задать вопросы про сохранение/загрузку можно на форуме.