basic-db.js v1.0.0

basic-db.js

Table of contents

• About
• Links
• Installation
• Setup
• File
• Server
  • Server Methods
    • Close
• Query
• Client
  • Client Methods
    • Send
• Methods
  • Add
  • Delete
  • Erase
  • Get
  • Keys
  • Pop
  • Push
  • Set
  • Shift
  • Shuffle
  • Subtract
  • Unpush
  • Unshift
  • Values

About

Basic Database System based on NodeJS.

• Basic usage
• Object-oriented
• Optimized
• Works on every node version after 8.0.0

Links

• GitHub
• NPM
• Website

Installation

Node.js 8.0.0 or newer is required.
Ignore any warnings about unsupported engine.

npm install basic-db.js --save

Setup

const BasicDB = require("basic-db.js");

File

const file = new BasicDB.File("pathToFile", { isSync: true, lineBreak: false });

Server

const server = new BasicDB.Server(file, { username: "root", password: "", port: 80 });

Server Methods

Server.close()

server.close();

Query

const query = "a.b";

const query = ["a", "b"];

Client

const client = new BasicDB.Client({ url: "http://localhost", username: "root", password: "", port: 80 });

Client Methods

Client.send()

client.send({ method: "add", query: "a.b", value: 1 });

Methods

Add

Adds new value to previous value.

// -> { a: { b: 0 } }
file.add("a.b", 1);
// -> { a: { b: 1 } }

Delete

Deletes marked key.

// -> { a: { b: null } }
file.delete("a.b");
// -> { a: {} }

Erase

Erases all data permanently.

// -> { a: { b: null } }
file.erase("a.b");
// -> {}

Get

Gets marked key.

// -> { a: { b: null } }
file.get("a.b");
// -> null

// -> { a: { b: null } }
file.get();
// -> { a: { b: null } }

Keys

Gets marked object's keys.

// -> { a: { b: null } }
file.keys("a");
// -> [ "b" ]

// -> { a: { b: null } }
file.keys();
// -> [ "a" ]

Pop

Removes marked array's last element.

// -> { a: { b: [ undefined ] } }
file.pop("a.b");
// -> { a: { b: [] } }

Push

Pushes new element to marked array.

// -> { a: { b: [] } }
file.push("a.b", undefined);
// -> { a: { b: [ undefined ] } }

Set

Sets value to marked key.

// -> { a: { b: null } }
file.set("a.b", 0);
// -> { a: { b: 0 } }

Shift

Removes marked array's first element.

// -> { a: { b: [ 0, 1 ] } }
file.shift("a.b");
// -> { a: { b: [ 1 ] } }

Shuffle

Shuffles marked array's elements.

// -> { a: { b: [ 0, 1, 2 ] } }
file.shuffle("a.b");
// -> { a: { b: [ 2, 0, 1 ] } }

Subtract

Subtracts new value from previos value.

// -> { a: { b: 1 } }
file.subtract("a.b", 1);
// -> { a: { b: 0 } }

Unpush

Removes marked array's given element. If there is more than same given element they'll deleted as well.

// -> { a: { b: [ 0, 1, 2 ] } }
file.unpush("a.b", 1);
// -> { a: { b: [ 0, 2 ] } }

Unshift

Inserts new elements at the start of marked array.

// -> { a: { b: [ 1, 2 ] } }
file.unshift("a.b", 0);
// -> { a: { b: [ 0, 1, 2 ] } }

Values

Gets marked object's values.

// -> { a: { b: null } }
file.values("a");
// -> [ { b: null } ]

// -> { a: { b: null } }
file.values();
// -> [ { b: null } ]