Fast & simple storage - a Node.js-style LevelDB wrapper (a convenience package bundling LevelUP & LevelDOWN) [HyperDex fork]
JavaScript
Latest commit d895ac2 Apr 20, 2016 @ralphtheninja ralphtheninja Merge pull request #14 from ralphtheninja/master
update travis
Permalink
Failed to load latest commit information.
.gitignore
.jshintrc
.travis.yml
LICENSE.md
README.md
level-hyper.js
package.json
test.js

README.md

level-hyper

LevelDB Logo

Fast & simple storage - a Node.js-style HyperLevelDB wrapper

NPM

Build Status dependencies

This is a convenience package that bundles the current release of LevelUP and LevelDOWN-Hyper and exposes LevelUP on its export.

Use this package to avoid having to explicitly install LevelDOWN-Hyper when you want to use LevelDOWN-Hyper with LevelUP.

Usage

Basic usage for putting and getting data:

var level = require('level-hyper')

// 1) Create our database, supply location and options.
//    This will create or open the underlying LevelDB store.
var db = level('./mydb')

// 2) put a key & value
db.put('name', 'Level', function (err) {
  if (err) return console.log('Ooops!', err) // some kind of I/O error

  // 3) fetch by key
  db.get('name', function (err, value) {
    if (err) return console.log('Ooops!', err) // likely the key was not found

    // ta da!
    console.log('name=' + value)
  })
})

The .liveBackup() method is accessible on the underlying LevelDOWN-Hyper object:

var level = require('level-hyper')
var db = level('./mydb')
db.on('ready', function () {
  var name = String(Date.now())
  db.db.liveBackup(name, function (err) {
    if (!err) console.log('backup to %s was successful', name)
  })
})

See LevelUP and LevelDOWN-Hyper for more details.

Contributing

level-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.

Licence & Copyright

Copyright (c) 2012-2016 level-hyper contributors.

level-hyper is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.