uberDB
A Lightweight Disk based JSON Database with a MongoDB like API for Node.
Contents
Getting Started
Install the module locally :
$ npm install uberdb
var db = ;db = db;// you can access the traditional JSON DB methods here
Documentation
Connect to DB
db;
Filename will be the name of the JSON file. You can omit the extension, uberDB will take care of it for you.
var db = ;db = db;// or simplydb;
This will check for a directory at given path, if it does not exits, uberDB will throw an error and exit.
If the directory exists but the file/collection does not exist, uberDB will create it for you.
Note : If you have manually created an empty JSON file, please make sure that it contains at least an empty array.
Else it will throw an error like
undefined:0 ^SyntaxError: Unexpected end of input
Load Collections
Alternatively you can also load collections like
var db = ;// thisdb = db;db;//ordb;db;//ordb ;//ordb;
Load Multiple Collections
var db = ;db;
Write/Save to Collection
dbcollectioName;
Once you have loaded a collection, you can access the collection's methods using the dot notation like
dbcollectionNamemethodname
To save the data, you can use
var db = ;db;var article = title : "uberDB rocks" published : "today" rating : "5 stars"dbarticles;// ordbarticles;
The saved data will be
"title": "uberDB rocks" "published": "today" "rating": "5 stars" "_id": "0f6047c6c69149f0be0c8f5943be91be"
You can also save multiple objects at once like
var db = ;db;var article1 = title : 'uberDB rocks' published : 'today' rating : '5 stars' var article2 = title : 'uberDB rocks' published : 'yesterday' rating : '5 stars' var article3 = title : 'uberDB rocks' published : 'today' rating : '4 stars'dbarticles;
And this will return the inserted objects
title: 'uberDB rocks' published: 'today' rating: '4 stars' _id: 'b1cdbb3525b84e8c822fc78896d0ca7b' title: 'uberDB rocks' published: 'yesterday' rating: '5 stars' _id: '42997c62e1714e9f9d88bf3b87901f3b' title: 'uberDB rocks' published: 'today' rating: '5 stars' _id: '4ca1c1597ddc4020bc41b4418e7a568e'
Read from Collection
There are 2 methods available for reading the JSON collection
- db.collectioName.find(query)
- db.collectioName.findOne(query)
db.collectioName.find()
var db = ;db;dbarticles;
This will return all the records
title: 'uberDB rocks' published: 'today' rating: '5 stars' _id: '0f6047c6c69149f0be0c8f5943be91be'
You can also query with a criteria like
var db = ;db;dbarticles;
This will return all the articles which have a rating of 5.
Nested JSON :
var articleComments = title: 'uberDB rocks' published: '2 days ago' comments: name: 'a user' comment: 'this is cool' rating: 2 name: 'b user' comment: 'this is ratchet' rating: 3 name: 'c user' comment: 'this is awesome' rating: 2
var savedArticle = dbarticles;foundArticles = dbarticles;
Since uberDB is mostly for light weight data storage, avoid nested structures and huge datasets.
db.collectioName.findOne(query)
var db = ;db;dbarticles;
If you do not pass a query, uberDB will return the first article in the collection. If you pass a query, it will return first article in the filtered data.
var db = ;db;dbarticles;
Update Collection
dbcollectioName;
You can also update one or many objects in the collection
options = multi: false // update multiple - default false upsert: false // if object is not found, add it (update-insert) - default false
Usage
var db = ;db; var query = title : 'uberDB rocks'; var dataToBeUpdate = title : 'uberDB rocks again!'; var options = multi: false upsert: false; var updated = dbarticles;console; // { updated: 1, inserted: 0 }
Remove Collection
dbcollectioName;
You can remove the entire collection (including the file) or you can remove the matched objects by passing in a query. When you pass a query, you can either delete all the matched objects or only the first one by passing multi
as false
. The default value of multi
is true
.
var db = ;db;dbarticles;
var db = ;db;dbarticles; // remove all matched. Default - multi = true
var db = ;db;dbarticles; // remove only the first match
Using remove without any params will delete the file and will remove the db instance.
var db = ;db;dbarticles;
After the above operation db.articles
is undefined
.
Count
dbcollectioName;
Will return the count of objects in the Collection
var db = ;db;dbarticles; // will give the count
Examples
Refer to the examples folder.
Release History
- 0.1.x
- Base Module with
- Connect to a Folder
- Access a Collection/File
- Create Read Update Delete on JSON object
- Minor fixes and tests
- Performance improvements
- Base Module with
License
Copyright (c) 2015 Roger Stringer. Licensed under the MIT license.