SQLiteチュートリアル(9):オンラインバックアップ
以下の方法は比較的簡単でよく用いられるSQLiteデータベースのバックアップ方式であり、以下の手順を参照する:1).SQLite APIまたはShellツールを使用して、ソース・データベース・ファイルに共有ロックを追加します. 2). Shellツール(cpまたはcopy)を使用して、データベース・ファイルをバックアップ・ディレクトリにコピーします. 3). データベース・ファイルの共有ロックを解除します.以上の3つのステップは、多くのシーンに適用することができ、速度も比較的速いが、例えば:1)のような剛性欠陥がある.ソース・データベースで書き込みを実行するすべての接続は、コピー・プロシージャ全体が終了し、ファイル共有ロックが解放されるまで保留されなければなりません. 2). in-memoryデータベースにデータをコピーできません. 3). コピー中に、バックアップ・データベースが存在するホストに突発的な障害が発生すると、バックアップ・データベースが破壊される可能性があります.SQLiteには、オンライン・データベースのバックアップに使用されるAPIs関数(Cインタフェース)のセットが用意されており、上記の方法の不足をうまく解決することができます.この関数のセットを使用すると、ソース・データベースの内容を別のデータベースにコピーし、ターゲット・データベースのデータを上書きできます.コピー・プロシージャ全体をインクリメンタルで完了できます.この場合、ソース・データベースも、コピー・プロシージャ全体にロックをかける必要はありません.実際にデータを読み込むときに共有ロックを追加するだけです.これにより、他のユーザーはソース・データベースにアクセスするときに保留されません.二、オンラインバックアップAPIs紹介:
SQLiteでは、以下の3つのAPIs関数を使用してこの操作を完了します.ここでは、SQLiteの公式サイト「APIs Reference」(http://www.sqlite.org/c3ref/backup_finish.html). 1). 関数sqlite 3_backup_init()はsqlite 3_を作成するために使用されます.backupオブジェクト.このコピー操作のハンドルとして残りの2つの関数に渡されます. 2). 関数sqlite 3_backup_Step()はデータコピーに使用され、関数の2番目のパラメータが-1の場合、コピープロセス全体が関数の1回の呼び出しで完了します. 3). 関数sqlite 3_backup_finish()はsqlite 3_を解放するために使用されます.backup_Init()関数は、リソースの漏洩を回避するためにリソースを申請します.コピー中にエラーが発生した場合は、宛先データベース接続のsqlite 3_を呼び出すことができます.Errcode()関数を使用して、特定のエラーコードを取得します.また、sqlite 3_backup_Step()呼び出しに失敗しました.sqlite 3_のためです.backup_finish()関数は、現在の接続のエラーコードを変更しないため、sqlite 3_を呼び出すことができます.backup_finish()の後にエラーコードを取得することで、コード内でエラー処理を1回減らすことができます.次のコード例を参照してください(SQLite公式サイトから):
/*
** 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.
*/
int loadOrSaveDb(sqlite3 *pInMemory, const char *zFilename, int isSave){
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 = (isSave ? pInMemory : pFile);
pTo = (isSave ? 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);
return rc;
}
三、高度な応用技術:上記の例では、sqlite 3_を通じてbackup_Step()関数の1回の呼び出しでコピープロセス全体が完了しました.なお、本実施形態では、前述のように他の書き込みアクセス接続を保留するという問題が依然として存在するが、この問題を解決するために、ここではさらに高度な実装形態であるスライスコピーについて説明するが、その実装手順は以下の通りである:1).関数sqlite 3_backup_init()はsqlite 3_を作成するために使用されます.backupオブジェクト.このコピー操作のハンドルとして残りの2つの関数に渡されます. 2). 関数sqlite 3_backup_Step()は、データのコピーに呼び出され、以前の方法とは異なり、この関数の2番目のパラメータは-1ではなく、呼び出しごとにコピーされるページの数、例えば5を表す通常の正の整数である. 3). 関数sqlite 3_でbackup_Step()呼び出しが終了する後も、より多くのページがコピーされる必要がある場合は、250 msをアクティブにスリープし、ステップ2を繰り返す. 4). 関数sqlite 3_backup_finish()はsqlite 3_を解放するために使用されます.backup_Init()関数は、リソースの漏洩を回避するためにリソースを申請します.上記の手順3)では、250 msをアクティブにスリープしています.この期間、コピー・オペレーションはソース・データベースにリード・ロックを保持しません.これにより、他のデータベース接続は書き込み中に停止されません.しかし、スリープ中にソース・データベースに別のスレッドまたはプロセスが書き込みを行った場合、SQLiteはイベントの発生を検出し、次のsqlite 3_を呼び出す.backup_Step()関数でコピープロセス全体を再開します.唯一の例外は、ソース・データベースがin-memoryデータベースではなく、書き込み操作がコピー操作と同じプロセス内で完了し、操作時に同じデータベース接続ハンドルが使用されている場合、宛先データベースのデータも自動的に変更されます.次の呼び出しでsqlite 3_backup_Step()の場合も、何の影響もありません.実際、SQLiteでは他の2つの補助関数backup_が提供されています.remaining()とbackup_pagecount()は、前者が現在のバックアップ操作でコピーするページがどれだけあるかを返し、後者は今回の操作でコピーするページの合計数を返します.この2つの関数の結果を返すと、このバックアップ操作の全体的な進捗状況をリアルタイムで表示できます.計算式は、Completion=100%*(pagecount()-remaining()/pagecount()次のコード例(SQLite公式サイトから)を参照してください.
/*
** Perform an online backup of database pDb to the database file named
** by zFilename. This function copies 5 database pages from pDb to
** zFilename, then unlocks pDb and sleeps for 250 ms, then repeats the
** process until the entire database is backed up.
**
** The third argument passed to this function must be a pointer to a progress
** function. After each set of 5 pages is backed up, the progress function
** is invoked with two integer parameters: the number of pages left to
** copy, and the total number of pages in the source file. This information
** may be used, for example, to update a GUI progress bar.
**
** While this function is running, another thread may use the database pDb, or
** another process may access the underlying database file via a separate
** connection.
**
** If the backup process is successfully completed, SQLITE_OK is returned.
** Otherwise, if an error occurs, an SQLite error code is returned.
*/
int backupDb(
sqlite3 *pDb, /* Database to back up */
const char *zFilename, /* Name of file to back up to */
void(*xProgress)(int, int) /* Progress function to invoke */
){
int rc; /* Function return code */
sqlite3 *pFile; /* Database connection opened on zFilename */
sqlite3_backup *pBackup; /* Backup handle used to copy data */
/* Open the database file identified by zFilename. */
rc = sqlite3_open(zFilename, &pFile);
if( rc==SQLITE_OK ){
/* Open the sqlite3_backup object used to accomplish the transfer */
pBackup = sqlite3_backup_init(pFile, "main", pDb, "main");
if( pBackup ){
/* Each iteration of this loop copies 5 database pages from database
** pDb to the backup database. If the return value of backup_step()
** indicates that there are still further pages to copy, sleep for
** 250 ms before repeating. */
do {
rc = sqlite3_backup_step(pBackup, 5);
xProgress(
sqlite3_backup_remaining(pBackup),
sqlite3_backup_pagecount(pBackup)
);
if( rc==SQLITE_OK || rc==SQLITE_BUSY || rc==SQLITE_LOCKED ){
sqlite3_sleep(250);
}
} while( rc==SQLITE_OK || rc==SQLITE_BUSY || rc==SQLITE_LOCKED );
/* Release resources allocated by backup_init(). */
(void)sqlite3_backup_finish(pBackup);
}
rc = sqlite3_errcode(pFile);
}
/* Close the database connection opened on database file zFilename
** and return the result of this function. */
(void)sqlite3_close(pFile);
return rc;
}