SparkDB

SparkDB is a server-based database framework for those who like to work with JSON and Firebase-like methods.

What it can do

SparkDB is able (at this actual version) to create, read, delete and update databases and its documents. It can also listen for realtime updates at databases and documents specifically. You can work with SparkDB with the methods framework and the command-line version, which can only create and delete databases/documents, it also cannot listen for realtime updates, but it can change the configurations for the SPARK file.

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Table of contents

• SparkDB
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
  • Library
  • Credits
  • Built With
  • Authors
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the library, run:

$ npm install spark-db

Or if you prefer using Yarn:

$ yarn add --dev spark-db

Usage

Starting SparkDB

$ node spark-db start

Creating a new database

$ node spark-db create db

or

$ node spark-db create db myDB

Delete all your DBs and reset SparkDB

$ node spark-db finish confirm true

Other commands

There are other important commands that can make your DB even better, here are some examples:

$ node spark-db restart db myDB
$ node spark-db create doc myDoc
$ node spark-db create log TYP Type "My log message"
$ node spark-db logs
$ node spark-db config
$ node spark-db config raw true
$ node spark-db config raw false

About SPARK file

You may be wondering what is this 'db.spark' file. Well, it's the file you are going to use to change SparkDB's default configs, such as default DB folder. When you type node spark-db config raw [bool] on your temrminal, you are accessing this file, if raw true, it will show the SPARK file without converting it to an object, if raw false, it converts the SPARK file to a javascript object, that can be converted to a JSON file later, if you want.

Library

Setup

To work with SparkDB's library, you will need to do a quick setup on your workspace.

const db = require('spark-db');

After that, you are free to use SparkDB's methods.

Some methods

readData

SparkDB works with an asynchronous method system, so will need to wait until the promise is fullfiled before going on with your code. Here is an example:

const defaultFolder = 'db/'

db.readData(defaultFolder+'myDB.json')
  then((data) => {
    console.log(data)
  })

or

var data = await db.readData(defaultFolder+'myDB.json')
console.log(data)

There are other methods on SparkDB's library, they are listed on the documentation, which is under development yet, wait for updates! :)

Credits

It's just me, so... yeah.

Built With

• NodeJS
• Love :)

Authors

• matjs - matjsilva

See also the list of contributors who participated in this project.

License

MIT License © matjs