Skip to content

Belphemur/node-json-db

develop
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

NodeJs codecov npm version

A simple "database" that use JSON file for Node.JS.

Breaking changes since v1.x.x

v2.0.0

JsonDB is now using the concept of async/await for all its calls since we read from the database file on demands and depending on how the database is configured, we might write at each push.

  • You're now forced to use the Config object to setup JsonDB
  • Every method are now asynchronous

Installation

Add node-json-db to your existing Node.js project.

yarn add node-json-db

Documentation

Auto Generated

Inner Working

Data

The module stores the data using JavaScript Object directly into a JSON file. You can easily traverse the data to reach directly the interesting property using the DataPath. The principle of DataPath is the same as XMLPath.

Example

{
    test: {
        data1 : {
            array : ['test','array']
        },
        data2 : 5
    }
}

If you want to fetch the value of array, the DataPath is /test/data1/array To reach the value of data2 : /test/data2 You can of course get also the full object test : /test Or even the root : /

Usage

See test for more usage details.

import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'

// The first argument is the database filename. If no extension, '.json' is assumed and automatically added.
// The second argument is used to tell the DB to save after each push
// If you put false, you'll have to call the save() method.
// The third argument is to ask JsonDB to save the database in an human readable format. (default false)
// The last argument is the separator. By default it's slash (/)
var db = new JsonDB(new Config("myDataBase", true, false, '/'));

// Pushing the data into the database
// With the wanted DataPath
// By default the push will override the old value
await db.push("/test1","super test");

// It also create automatically the hierarchy when pushing new data for a DataPath that doesn't exists
await db.push("/test2/my/test",5);

// You can also push directly objects
await db.push("/test3", {test:"test", json: {test:["test"]}});

// If you don't want to override the data but to merge them
// The merge is recursive and work with Object and Array.
await db.push("/test3", {
    new:"cool",
    json: {
        important : 5
    }
}, false);

/*
This give you this results :
{
   "test":"test",
   "json":{
      "test":[
         "test"
      ],
      "important":5
   },
   "new":"cool"
}
*/

// You can't merge primitive.
// If you do this:
await db.push("/test2/my/test/",10,false);

// The data will be overriden

// Get the data from the root
var data = await db.getData("/");

// From a particular DataPath
var data = await db.getData("/test1");

// If you try to get some data from a DataPath that doesn't exists
// You'll get an Error
try {
    var data = await db.getData("/test1/test/dont/work");
} catch(error) {
    // The error will tell you where the DataPath stopped. In this case test1
    // Since /test1/test does't exist.
    console.error(error);
};

// Deleting data
await db.delete("/test1");

// Save the data (useful if you disable the saveOnPush)
await db.save();

// In case you have a exterior change to the databse file and want to reload it
// use this method
await db.reload();

TypeScript Support

v0.8.0

As of v0.8.0, TypeScript types are included in this package, so using @types/node-json-db is no longer required.

v1.0.0

JsonDB isn't exported as default any more. You'll need to change how you load the library.

This change is done to follow the right way to import module.

import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'

const db = new JsonDB(new Config("myDataBase", true, false, '/'));

Typing

With TypeScript, you have access to a new method: getObject that will take care of typing your return object.

import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'

const db = new JsonDB(new Config("myDataBase", true, false, '/'));

interface FooBar {
    Hello: string
    World: number
}
const object = {Hello: "World", World: 5} as FooBar;

await db.push("/test", object);

//Will be typed as FooBar in your IDE
const result = await db.getObject<FooBar>("/test");

Array Support

You can also access the information stored into arrays and manipulate them.

import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'

// The first argument is the database filename. If no extension, '.json' is assumed and automatically added.
// The second argument is used to tell the DB to save after each push
// If you put false, you'll have to call the save() method.
// The third argument is to ask JsonDB to save the database in an human readable format. (default false)
const db = new JsonDB(new Config("myDataBase", true, false, '/'));

// This will create an array 'myarray' with the object '{obj:'test'}' at index 0
await db.push("/arraytest/myarray[0]", {
    obj:'test'
}, true);

// You can retrieve a property of an object included in an array
// testString = 'test';
var testString = await db.getData("/arraytest/myarray[0]/obj");

// Doing this will delete the object stored at the index 0 of the array.
// Keep in mind this won't delete the array even if it's empty.
await db.delete("/arraytest/myarray[0]");

Appending in Array

// You can also easily append new item to an existing array
// This set the next index with {obj: 'test'}
await db.push("/arraytest/myarray[]", {
    obj:'test'
}, true);


// The append feature can be used in conjuction with properties
// This will set the next index as an object {myTest: 'test'}
await db.push("/arraytest/myarray[]/myTest", 'test', true);

Last Item in Array

// Add basic array
await db.push("/arraytest/lastItemArray", [1, 2, 3], true);

// You can easily get the last item of the array with the index -1
// This will return 3
await db.getData("/arraytest/lastItemArray[-1]");


// You can delete the last item of an array with -1
// This will remove the integer "3" from the array
await db.delete("/arraytest/lastItemArray[-1]");

// This will return 2 since 3 just got removed
await db.getData("/arraytest/lastItemArray[-1]");

Count for Array

//
await db.push("/arraytest/list", [{id: 65464646155, name: "test"}], true);

// You can have the number of element, in this case  = 1
let numberOfElement = await db.count("/arraytest/list");

Get Index in Array

// You can have the current index of an object
await db.push("/arraytest/myarray", {id: 65464646155, name: "test"}, true);
await db.getIndex("/arraytest/myarray", 65464646155);
// By default, the property is 'id'
// You can add another property instead
await db.getIndex("/arraytest/myarray", "test", "name");

// It's useful if you want to delete some object
await db.delete("/arraytest/myarray[" + await db.getIndex("/arraytest/myarray", 65464646155) + "]");

Nesting in Array

// You can easily access any nested array and their object
//You can also append to nested array other array
await db.push("/arraytest/myarray",
[
  [
    {
      obj: 'test'
    },
    {
      obj: 'hello'
    }
  ],
  [
    {
      obj: 'world'
    }
  ]
]
, true);

//This will return the first object (obj: 'test')

await db.getData("/arraytest/myarray[0][0]");

Exception/Error

Type

Type Explanation
DataError When the error is linked to the Data Given
DatabaseError Linked to a problem with the loading or saving of the Database.

Errors

Error Type Explanation
The Data Path can't be empty DataError The Database expect to minimum receive the root separator as DataPath.
Can't find dataPath: /XXX. Stopped at YYY DataError When the full hierarchy of the DataPath given is not present in the Database. It tells you until where it's valid. This error can happen when using getData and delete
Can't merge another type of data with an Array DataError If you chose to not override the data (merging) when pushing and the new data is an array but the current data isn't an array (an Object by example).
Can't merge an Array with an Object DataError Same idea as the previous message. You have an array as current data and ask to merge it with an Object.
DataPath: /XXX. YYY is not an array. DataError When trying to access an object as an array.
DataPath: /XXX. Can't find index INDEX in array YYY DataError When trying to access a non-existent index in the array.
Only numerical values accepted for array index DataError An array can only use number for its indexes. For this use the normal object.
The entry at the path (/XXX) needs to be either an Object or an Array DataError When using the find method, the rootPath need to point to an object or an array to search into it for the wanted value.
Can't Load Database: XXXX DatabaseError JsonDB can't load the database for "err" reason. You can find the nested error in error.inner
Can't save the database: XXX DatabaseError JsonDB can't save the database for "err" reason. You can find the nested error in error.inner
DataBase not loaded. Can't write DatabaseError Since the database hasn't been loaded correctly, the module won't let you save the data to avoid erasing your database.

Limitations

Object with separator in key

Object pushed with key containing the separator character won't be reachable. See #75.

Please consider the separator as a reserved character by node-json-await db.

Contributors


Jamie Davis

🛡️

sidblommerswork

💻 ⚠️

Max Huber

💻

Special Thanks

James Davis for helping to fix a regular expression vulnerable to catastrophic backtracking.

License

![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FBelphemur%2Fnode-json-await db.svg?type=large)