Skip to content
replicate or make a backup of a hyperleveldb, taking advantage of the liveBackup function
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.gitignore
LICENSE
index.js
package.json
readme.md

readme.md

hyperlevel-backup

NPM

High level API for replicating a hyperleveldb, taking advantage of the .liveBackup function provided by hyperleveldb.

Unfortunately .liveBackup does not exist in stock google leveldb.

.liveBackup creates a consistent snapshot of a running hyperleveldb instance. the files are hardlinks where possible to the originals. this module implements methods for streaming the contents of a leveldb folder as a .tar.gz stream and unpacking them on the other end, for doing replication or backups of hyperleveldb instances.

var hlc = require('hyperlevel-backup')

API

hlb(hyper, opts, httpResponse)

function for mounting this module in an http API. creates a snapshot of a hyperleveldb instance, and then streams a tar.gz of the files to the httpResponse

opts must have at least these keys:

{
  hyper: hyperleveldbInstance,
  dir: pathToHyperleveldbFolder
}

and can optionally also have:

{
  onCleanup: function() {}, // gets called when the snapshot gets removed after replication
  backupName: string/int, // used to name the backup folder, default is a timestamp
  cleanup: boolean // default true, if false snapshot won't be removed after replication
}

license

BSD

Something went wrong with that request. Please try again.