npm.io
2.0.2 • Published 4 years ago

sqlite3-incremental-backup

Licence
GPL-3.0-or-later
Version
2.0.2
Deps
0
Size
8 kB
Vulns
0
Weekly
0
Stars
20

sqlite3-incremental-backup

This Module can be used to incrementally backup your database which will reduce the needed Backup size.

Installation

For Installation Please Use npm command as follows: npm install sqlite3-incremental-backup

Example

For Simple use case, use as follows :

import {backup, restore} from './sqlite3-incremental-backup';
const srcFile = 'source.db';
const targetFile = 'target.db';
const objectDirectory = "objects"
const snapshotName = 'snapshot1.txt'; //Can be any arbitrary name. MUST BE UNIQUE FOR EACH SNAPSHOT OTHERWISE THE PREVIOUS WILL BE LOST
backup(srcFile, snapshotName, objectDirectory); // For Backup
restore(snapshotName, targetFile, objectDirectory); // For Restoration
backup(srcFile, snapshotName, objectDirectory, () => restore(snapshotName, targetFile, objectDirectory)); // For Backup and immediate restoration, only for testing

Note : Both backup and restore functions are asynchronous.