Skip to content
/ ueberDB Public
forked from ether/ueberDB

transform every database into a object key value store, written in node.js

License

Notifications You must be signed in to change notification settings

jots/ueberDB

 
 

Repository files navigation

#About

ueberDB is a abstraction layer for databases. It turns every database into a simple key value store, at the moment we only support mysql and sqlite. ueberDB uses a smart cache and buffer algorithm to make databases faster. Reads are cached and writes are done in a bulk. The bulk writing reduces the overhead of a database transaction.

#Install

npm install ueberDB

#Example

var ueberDB = require("ueberDB");

//mysql
var db = new ueberDB.database("mysql", {"user":"root", host: "localhost", "password":"", database: "store"});
//sqlite in-memory
//var db = new ueberDB.database("sqlite");
//sqlite in file
//var db = new ueberDB.database("sqlite", {filename:"var/sqlite3.db"});
//sqlite in file with a write interval of a half second
//var db = new ueberDB.database("sqlite", {filename:"var/sqlite3.db"}, {writeInterval: 500});

//initialize the database
db.init(function (err)
{
  if(err) 
  {
    console.error(err);
    process.exit(1);
  }

  //set a object as a value
  //can be done without a callback, cause the value is immediately in the buffer
  db.set("valueA", {a:1,b:2});
  
  //get the object
  db.get("valueA", function(err, value){
    console.log(value);
    
    db.close(function(){
      process.exit(0);
    });
  });
});

#How to add support for another database Look at sqlite_db.js and mysql_db.js, your module have to provide the same functions. Call it DATABASENAME_db.js and reimplement the functions for your database. If you think it works, test it with node benchmark.js DATABASENAME. Benchmark.js is benchmark and test at the same time. It tries to set 100000 values. You can pipe stderr to a file and will create a csv with benchmark results.

#License is Apache v2

About

transform every database into a object key value store, written in node.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published