Skip to content
This repository has been archived by the owner on Apr 1, 2019. It is now read-only.

Latest commit

 

History

History
52 lines (34 loc) · 1.97 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.97 KB

level-lmdb

This project has been abandoned. There will be no further releases. If you wish to revive level-lmdb, please open an issue in Level/community to discuss a way forward. Thank you! ❤️


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

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

Use this package to avoid having to explicitly install LMDB when you want to use LMDB with LevelUP.

var level = require('level-lmdb')

// 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)
  })
})

See LevelUP and LMDB for more details.

Contributing

level-lmdb 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 CONTRIBUTING.md file for more details.

Licence & copyright

Copyright (c) 2012-2013 Rod Vagg contributors (listed above).

level-lmdb is licensed under an MIT +no-false-attribs license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.