nzfsdb

nzfsdb is a library nosql database.

Table of Contents

• nzfsdb
  • Getting started
    • Node.js
  • Example
  • License

nzfsdb

• nzfsdb allows you to create nosql databases in the file system.

• The index.js bundle works well in Node.js. It is used by default when you require('nzfsdb') in Node.js.

Getting started

Node.js

Install nzfsdb using npm:

npm install nzfsdb

And import it as a CommonJS module:

const nzfsdb = require('nzfsdb');

Example

Here is an example of using this class in a project.

const nzfsdb = require('nzfsdb');

const DB = new nzfsdb(__dirname + '/DB/');

console.log('1. Checking the database root folder:\n', DB.checkExists(), '\n');
console.log('2. Checking the "pub" folder of the database:\n', DB.checkExists('pub'), '\n');
console.log('3. Checking file "123.txt" in folder "pub":\n', DB.checkExists('pub', '123.txt'), '\n');
console.log('4. Reading the list of files in the "pub" folder:\n', DB.read('pub'), '\n');
console.log('5. Writing file "12345.txt" to folder "pub/some/dir" with content "test":', DB.write('pub/some/dir', '12345.txt', 'test'), '\n');	// comment this line later
console.log('6. Reading the list of files in the "pub/some/dir" folder:\n', DB.read('pub/some/dir'), '\n');
console.log('7. Reading file "12345.txt" in folder "pub/some/dir":', DB.read('pub/some/dir', '12345.txt'), '\n');
console.log('8. Deleting file "12345.txt" in folder "pub/some/dir":', DB.delete('pub/some/dir', '12345.txt'), '\n');
console.log('9. Deleting the "some" folder and all its data:', DB.delete('pub/some'), '\n');

License

GNU Lesser General Public License (3.0 or any later version). Please take a look at the LICENSE file for more information.