Nutella with Pepperoni and Mushrooms
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    dumbdbpublic

    dumbdb.js

    summary

    dumbdb ain't couchdb.

    it's an attempt to do the simplest nodb possible, using just core JS stuff.

    each collection is a JS object used as a hash (duh).

    collections are persisted to disk every n seconds.

    _ids are auto generated if ommitted.

    there are no _revs or attachments... or synchronization magic either.

    you can spawn an http interface though, using dumbdb_srv! :)

    otherwise, you get an in-process kinda-db-thingy. if so, be careful since dumb doesn't clone given objects by default.

    does it scale? probably not. what's the purpose? fun and a little bit of learning. KISS was the main concern here.

    API

    require

    the require returns a function which can receive configuration options, namely:

    • saveEveryNSeconds (defaults to 5)
    • rootDir (defaults to __dirname, i.e., the current directory collections are read/saved to)
    • verbose (defaults to false, iif true prints out additional info to stdout)
    • timestamps (defaults to true, sets _createdAt and _modifiedAt keys on objects)

    var dumbdb = require('dumbdb')({verbose:true});

    create and open collection

    from that, you can either open or create a collection. (will be stored as <collection_name>.ddb)

    dumbdb.create({String} collectionName, [{Boolean} openIfExistent], Function({String} err, {Collection} coll))

    dumbdb.open({String} collectionName, [{Boolean} createIfInexistent], Function({String} err, {Collection} coll))

    collection methods

    once you create/open a collection you get this interface:

    {Boolean} <coll>.exists({String} id) to find if item exists (id is assigned)

    {Object|null} <coll>.get({String} id, [{Number} rev]) gets the object assigned to the id, optionally a revision other than the last one

    {Object} <coll>.put({Object} o) saves the given object, creating a new revision

    {Boolean} <coll>.del({String} id) deletes the object

    {Object[]} <coll>.getRevisions({String} id) returns item revisions

    {Number[]} <coll>.getRevisionDates({String} id) returns item revision dates

    {Boolean} <coll>.restore({String} id, [{Number} rev]) restores an object's revision

    <coll>.discardRevisions() discards revisions, making the actual one revision 1

    clear() removes all items from a collection

    close() closes a collection (no longer usable for the session)

    drop() closes and delete data from disk

    {Object[]} <coll>.all() returns all items of the collection

    {Object[]} <coll>.mapReduce({Function({Object} doc, [{Function({String} key, {Array} values)})

    the mapping function must invoke this.emit(key, value) to publish rows. reduction is optional. there are some auxiliary methods to aid in common reductions (this.sum(arr), this.factor(arr), this.avg(arr)).

    Keywords

    none

    install

    npm i dumbdb

    Downloadslast 7 days

    1

    version

    0.0.7

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar