leveldown-hyper is a fork of
leveldown and uses
HyperLevelDB as backend. It extends the
leveldown api with functionality to do live backups. This README only documents the
liveBackup() method. For a complete reference we refer to
leveldown can be considered an upstream repository to
leveldown-hyper and any common logic and bug fixes will be merged from upstream into this repository.
If you are upgrading: please see UPGRADING.md.
liveBackup() is an instance method on an existing database object, used to make a live backup of the current state of the database.
name parameter is a
String. A successful live backup will result in a backup folder named
backup-:name inside the
location folder of the current database.
callback function will be called with no arguments when a live backup was successful, or with a single
error argument if the backup operation failed for any reason.
leveldown-hyper is an OPEN Open Source Project. This means that:
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
See the contribution guide for more details.
leveldown-hyper builds on the excellent work of the
HyperLevelDB team and the LevelDB and Snappy teams from Google and additional contributors. HyperLevelDB, LevelDB and Snappy are issued under the New BSD Licence.