0.0.3 • Published 12 months ago

dualdb v0.0.3

Weekly downloads
-
License
ISC
Repository
-
Last release
12 months ago

Sure, here's the translation to English:

Methods

You can use the manager's methods according to your convenience. To read data, you have two functions: one where the return method is an object {}, and another where you get the exact result.

/data
	/users
		/1
		/2
	/posts
		/1
		/2

We will request data using the method: getData():

const dualdb = require('dualdb');
const database = new dualdb('./');

database.getData('/data/users');

// RESULT

{
	1: {
		user: "siopś",
		password: "***"
	},
	2: {
		user: "dualdb",
		password: "***"
	}
}

// IF THE DIRECTORY DOESN'T EXIST OR THERE IS NO DATA INSIDE THAT DIRECTORY, IT WILL RETURN THE FOLLOWING:

{}

// THIS IS USEFUL WHEN YOUR PROGRAM NEEDS TO CONTINUE READING EVEN IF THERE IS NO DIRECTORY.
// BUT IF YOU NEED TO KNOW THE ORIGINAL CONTENT OR IF IT DOESN'T EXIST, YOU CAN USE THE METHOD

database.initData('/data/users');

// RESULT

{
	1: {
		user: "siopś",
		password: "***"
	},
	2: {
		user: "dualdb",
		password: "***"
	}
}

// OBVIOUSLY, IT WILL GIVE THE SAME RESULT. HOWEVER, IT WON'T HAVE THE SAME EFFECT IF WE DELETE THE DIRECTORY.

// IF THE DIRECTORY DOESN'T EXIST, THE METHOD WILL RETURN NULL.

Set Data

To save information, you have to specify the path where you want to save the information and you can also send an object that will be converted into directories and files separately.

const dualdb = require('dualdb');
const database = new dualdb('./');

database.setData('/data', {
	users: [{user: "siops", password:"***"}, {user: "dualdb", password: "***"}];
})

This will generate the following paths:

/data/users/0/user.fdb => siops
/data/users/1/user.fdb => dualdb
/data/users/0/password.fdb => 'psw'
/data/users/1/password.fdb = 'psw'

Thus, generating the directories.

The getData() method will retrieve the same JSON that you passed with setData(), meaning that calling getData() will return the following: users: {0: {user: "siops", password:"***"}, 1: {user: "dualdb", password: "***"}}

Remove Data

Deleting files is quite simple, you specify the base path you want to delete:

// THIS WILL COMPLETELY DELETE ALL USERS.
// THE BASE DIRECTORY IS COMPLETELY REMOVED.
database.removeData('/data/users');

Start

The start() method is used to read all the data from the base path, i.e., the path you set when instantiating the class. This will read and convert all the data into a JSON object.