Giter VIP home page Giter VIP logo

tinydb's Introduction

TINYDB

Purpose

TinyDB is a tiny json file based database for NodeJS.
Normally, it's better to use it for your little project.

Features

  • auto save data in memory to local fild after add/delete item;
  • all APIs have a callback function for data handling;
  • name API refering to Mongoose;
  • no third-party dependencies.

Usage

var TinyDB = require('tinydb');
test_db = new TinyDB('./test.db');

test_db.onReady = function() {
  console.log('database is ready for operating');

  // set info to DB
  test_db.setInfo('title', 'Test DB', function(err, key, value) {
    if (err) {
      console.log(err);
      return;
    }
    
    console.log('[setInfo] ' + key + ' : ' + value);
  });
  
  // get info from DB
  test_db.getInfo('title', function(err, key, value) {
    if (err) {
      console.log(err);
      return;
    }
    
    console.log('[getInfo] ' + key + ' : ' + value);
  });
  
  // do other things below
  test_db.forEach(function (err, item) {
    if (err) {
      console.log(err);
      return;
    }

    for (var key in item) {
      console.log(key + ' : ' + item[key]);
    }
  });
}

APIs

.flush(callback)

Write the data in memory to your specified databse file immediately.

.find(query, callback)

Find databse items. query is a object like {_id: "xxxxx"}.

.findById(id, callback)

Find database item by id, equal to .find({_id: id}, callback);

.findByIdAndRemove(id, callback)

Find database item by id and remove it from database.

.insertItem(item, idx, callback)

Insert item to database. idx is optional, default to 0.

.appendItem(item, callback)

Append item to database.

Thanks

Source code of function ._guid() is refering to How to create a GUID / UUID in Javascript?.

Contact

mail : [email protected]

tinydb's People

Contributors

isayme avatar olivih avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.