Mira Database Docs

Download Releases

Welcome , The MIRA-DB It is open source (OOJSDB) distributed free of charge under the terms of the MIT License.

Download (@last-stable Releases) for Your Preferred Platform.

Windows and Linux Downloads

Install Binary (x86-64)

Linux Downloads

TAR-x86 TAR-x64

MAC Downloads

Please install NPM open-source

ARM Downloads

Please install NPM open-source

Windows, Mac, Arm, and various Linux distributions are supported (cross platform) , each both 32 and 64 bit.

Installation

Installing on Linux (Executable)

Please select your system architecture or Installer.

x64 - Linux distributions


sudo mkdir /home/miradb
cd /home/miradb
sudo wget https://github.com/Nodeclient/Mira-DB/releases/download/linux/miradb-x64-1.0.30.tar
sudo tar xvzf miradb-x64-1.0.30.tar
sudo chmod 777 miradb
sudo chmod 777 service
sudo chmod 777 run
sudo ./service 
sudo rm miradb-x64-1.0.30.tar

Terminal Command

you need to first switching to the (root) user before start miradb.

miradb (start | stop | restart)

x86 - Linux distributions


sudo mkdir /home/miradb
cd /home/miradb
sudo wget https://github.com/Nodeclient/Mira-DB/releases/download/linux/miradb-x86-1.0.30.tar
sudo tar xvzf miradb-x86-1.0.30.tar
sudo chmod 777 miradb
sudo chmod 777 service
sudo chmod 777 run
sudo ./service 
sudo rm miradb-x86-1.0.30.tar

Terminal Command

you need to first switching to the (root) user before start miradb.

miradb (start | stop | restart)

Debian-based Linux distributions

ARCH-INSTALL-x64


  git clone https://aur.archlinux.org/miradb.git
  cd miradb
  makepkg -siCc
  
  sh /usr/bin/miradb/service

Terminal Command

you need to first switching to the (root) user before start miradb.

miradb (start | stop | restart)

DEBIAN Linux distributions

DEB-INSTALL-x64


REPO: NOT READY YET

Terminal Command

miradb (start | stop | restart)

MIRA QUERY (GET,POST) :
http://localhost:8123/query

PUBLIC HTTP :
http://localhost:8123/

Web interface for database management Simple Admin (optional)
Also,you can should take a look at the configuration page , after install.

Installing Npm Package (open-source)

Install the dependencies in the local node_modules folder

npm install mira-db

Example : Local Database

local_DB.js

 
    // IMPORT MODULE
    const mira = require("mira-db");
    // YOUR APP PERMISSION
    var Perms = { SELECT:true,ADD:true,UNIQUE:true,UPDATE:true,RENAME:true,DROP:true,DELETE:true,CREATE:true,LIST:true }
    // DATABASE STORAGE FOLDER
    var Storage = __dirname + "/data";
    // DATABASE NAME
    var DB = "test";
    // CREATE NEW MIRA-DB OBJECT
    var new_database = new mira(Storage,DB,Perms,"UTF-8");
    //SET QUERY
    var query = 'SELECT TABLE person'

// RESULT (RETURN EXAMPLE)
    var result = new_database.Query(query);  
    console.log(  result );

// RESULT (CALLBACK EXAMPLE)
    new_database.Query(query ,function(result){
      console.log(  result );
    });

mira-localdb-source.zip

Example : Express Remote Database

The following install additional dependencies

npm install express@5.0.0-alpha.7 -g
npm install body-parser

Create The Following Files

user.conf
youraccess.perm
express_Server_db.js

Create The Following Folders

/public
/data

user.conf

  
    # Example Conf
    <root:null:youraccess:*>
    <admin:1234:youraccess:TEST_DB>

youraccess.perm


{
    "UNIQUE":true,
    "SELECT":true,
    "ADD":true,
    "UPDATE":true,
    "RENAME":true,
    "DROP":true,
    "DELETE":true,
    "CREATE":true,
    "LIST":true
}

express_Server_db.js

 
    // MIRA-DB EXPRESS REMOTE DATABASE
    var bodyParser = require("body-parser");
    // Express Build ver. (express@5.0.0-alpha.7)
    var express = require('express');
    var mira = require('mira-db');
    var UserData = require('mira-db').userdata;
    var app = express();
    var USR_PERM = {};
    // SET YOUR STORAGE FOLDER
    var DB_DIR = "./data";
    // MEMORY LIMIT
    var MAX_MEMORY = "100MB";
    
    app.use(express.static('public'));
    app.use(bodyParser.json({limit: MAX_MEMORY, extended: true}));
    app.use(bodyParser.urlencoded({limit: MAX_MEMORY, extended: true }));
    
    app.get('/', function (req, res, next) {
        res.sendFile( process.cwd()+'/public/index.html');
    });
    
    app.post('/query', function (req, res, next) {
            res.setHeader('Access-Control-Allow-Origin', '*');
            res.setHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS, PUT');
            res.setHeader('Access-Control-Allow-Headers', 'X-Requested-With,content-type');
            res.setHeader('Access-Control-Allow-Credentials', true);
    
        var DB_RESULT = null;
        var DB_NAME = req.body["db"];
        var DB_USER = req.body["user"];
        var DB_PASS = req.body["pass"];
        var DB_QUERY = req.body["query"];
    
        var expressDB = new mira(DB_DIR, DB_NAME, USR_PERM, "UTF-8");     
    
        var LOGIN_DATA = UserData.LoadLoginData("user.conf");
        if (LOGIN_DATA[0]) {
            var result = UserData.Login(DB_USER, DB_PASS, LOGIN_DATA);
            var USR_PERM = UserData.LoadPermsData(result["perm"] + ".perm");
            if (result) {
                DB_RESULT = expressDB.Query(DB_QUERY);
                res.status(200).send(DB_RESULT);
            } else {
                res.status(401).send([false,"LOGIN_ERROR","INVALID USERNAME OR PASSWORD",0]);
            }
        } else {
                res.status(500).send([false, "SERVER_ERROR", "INVALID CONF FILE", 100]);
        }
    });
    
    // YOU CAN CHANGE THE PORT
    var server = app.listen(8123);
    app.use((err, req, res, next) => {
        if (err){
             res.status(500).send([false, "SERVER_ERROR", "MEMORY ERROR", 100]);    
        }
    });
    
    console.log("MIRA-DB v:1.0.30 Port:8123");

mira-remotedb-source.zip

MIRA-DB configuration manual

Your Database server can be managed by multiple users. You can control each user's role, as well as control the scope of their MiraQuery access and their specific permission levels for that query access.

please visit installation directory to set configure files
Default (linux) : /home/miradb/
Default (windows) : c:/miradb/

Take a look at the following example configs :

USER SETTING

   
    USER_NAME:
    # [STRING] "white spaces" or "null" not allowed #
        
    PASSWORD:
    # [STRING] white spaces not allowed #
    # use "null" for disable password on remote login #
        
    PERMISSION_FILE_NAME:
    # [STRING] white spaces not allowed #
    # enter your permission file name | admin.perm -> "admin" #
            
    DATABASE_NAME:
    # [STRING] white spaces not allowed #
    # use "*" for multiple access #

user.conf

   
    # Example : "single" database access #
    <root:null:yourperm:MyDatabase>
        
    # Example : "multiple" database access #
    <admin:1234:youraccess:*>

PERMISSION SETTING


    # you can set (user) query access attribute (boolean) #
    # allow query  : "true" #
    # block query : "false" #
    # file type "JSON" #

    # query blocks
    "UNIQUE"
    "SELECT"
    "ADD"
    "UPDATE"
    "RENAME"
    "DROP"
    "DELETE"
    "CREATE"
    "LIST"

admin.perm


{
    "UNIQUE":true,
    "SELECT":true,
    "ADD":true,
    "UPDATE":true,
    "RENAME":true,
    "DROP":true,
    "DELETE":true,
    "CREATE":false,
    "LIST":true
}

MiraQuery Guide ( Usage , Example , etc..)

MiraQuery is a standard regular expression for storing, manipulating and retrieving data in databases. Our Querie tutorial will teach you how to use MiraQuery (let's beginning)

Useful Tip:

You can use this simple web admin database management to testing your query examples.

MiraQuery : UNIQUE

returns a dataset that contains only one observation for each unique combination of values for the strings in A specified in column.

UNIQUE COLUMN <COLUMN_NAME> TABLE <TABLE_NAME>;

Example Usage

db.query("UNIQUE COLUMN pass TABLE user",function(data,err){ 
    console.log(data); 
});

MiraQuery : SELECT

SELECT TABLE <TABLE_NAME>;

SELECT TABLE <TABLE_NAME> COUNT;

SELECT TABLE <TABLE_NAME> COLUMN [COLUMN_NAME];

SELECT TABLE <TABLE_NAME> LIMIT [START_NUMBER,END_NUMBER];

SELECT TABLE <TABLE_NAME> COLUMN [COLUMN_NAME] FIND ["SEARCH_STRING"];

SELECT TABLE <TABLE_NAME> COLUMN [COLUMN_NAME] FIND ["SEARCH_STRING"] LIKE;

Example Usage

the returned all the columns from the table

db.query("SELECT TABLE user;",function(data,err){ 
    console.log(data); 
});

Result:

the returned the number of rows

db.query("SELECT TABLE user COUNT;",function(data,err){ 
    console.log(data); 
});

Result:

the returned selected columns in the table

db.query("SELECT TABLE user COLUMN ["user","mail"];",function(data,err){ 
    console.log(data); 
});

Result:

the returned specify the number of records range (start-end)

db.query("SELECT TABLE user LIMIT ["1","2"];",function(data,err){ 
    console.log(data); 
});

Result:

finds rows that contain a specific string value in a column.

db.query("SELECT TABLE user COLUMN ["pass"] FIND ["1234"];",function(data,err){ 
    console.log(data); 
});

Result:

used in search for similar string of in a column

db.query("SELECT TABLE user COLUMN ["pass"] FIND ["1234"] LIKE;",function(data,err){ 
    console.log(data); 
});

Result:

MiraQuery : UPDATE

UPDATE ROW <TABLE_NAME> COLUMN [COLUMN_NAME] VALUE [STRING] FIND [COLUMN_NAME,"STRING"];

Example Usage

used to modify the existing records in a table.

db.query("UPDATE ROW user COLUMN ["user","pass","mail"] VALUE ["olivia","3333","olivia@example.com"] FIND ["user","mason"];",function(data,err){ 
        console.log(data); 
});

Result:

MiraQuery : ADD

ADD ROW  COLUMN [COLUMN_NAME] VALUE [STRING];

ADD COLUMN [COLUMN_NAME] TABLE <TABLE_NAME>;

Example Usage

insert new record in a data table.

db.query("ADD ROW COLUMN ["user","pass","mail"] VALUE ["arvin","6666","arvin@example.com"];",function(data,err){ 
    console.log(data); 
});

Result:

create new column in a data table.

db.query("ADD COLUMN ["hash"] TABLE user;",function(data,err){ 
    console.log(data); 
});

Result:

MiraQuery : RENAME

RENAME TABLE ["TABLE_NAME"] VALUE ["NEW_TABLE_NAME"];

RENAME DATABASE ["DATABASE_NAME"] VALUE ["NEW_DATABASE_NAME"];

RENAME COLUMN ["COLUMN_NAME"] TABLE <TABLE_NAME> VALUE ["STRING"];

Example Usage

to rename a table in data.

db.query("RENAME TABLE ["user"] VALUE ["login"]",function(data,err){ 
    console.log(data); 
});

Result:

to rename a database.

db.query("RENAME DATABASE ["DB_C"] VALUE ["NEW_C"];",function(data,err){ 
    console.log(data); 
});

Result:

to rename a column in table.

db.query("RENAME COLUMN ["email"] TABLE user VALUE ["e-mail"];",function(data,err){ 
    console.log(data); 
});

Result:

MiraQuery : DELETE

DELETE COLUMN [COLUMN_NAME] TABLE <TABLE_NAME>;

DELETE ROW <TABLE_NAME> COLUMN <COLUMN_NAME> VALUE ["SEARCH_STRING"];

DELETE ROW <TABLE_NAME> INDEX <INDEX_NUMBER>;

Example Usage

to delete a column in table

db.query("DELETE COLUMN ["mail"] TABLE user;",function(data,err){ 
    console.log(data); 
});

Result:

to delete a selected record in table

db.query("DELETE ROW USER COLUMN user VALUE ["fung"];",function(data,err){ 
    console.log(data); 
});

Result:

to delete selected row by index .

db.query("DELETE ROW user INDEX 4;",function(data,err){ 
    console.log(data); 
});

Result:

MiraQuery : CREATE

CREATE TABLE <TABLE_NAME> COLUMN ["COLUMN_NAME"] VALUE ["STRING"];

CREATE DATABASE <DATABASE_NAME>;

Example Usage

create a new table in a database

db.query("CREATE TABLE user COLUMN ["user","pass","mail"] VALUE ["mason","1234","mason@example.com"];",function(data,err){ 
    console.log(data); 
});

Result:

return value (success=true) (Failed=false)

create a new database

db.query("CREATE DATABASE DB_NEW;",function(data,err){ 
    console.log(data); 
});

Result:

return value (success=true) (Failed=false)

MiraQuery : DROP

DROP TABLE <TABLE_NAME>;

DROP DATABASE <DATABASE_NAME>;

Example Usage

to delete a table

db.query("DROP TABLE user;",function(data,err){ 
    console.log(data); 
});

Result:

return value (success=true) (Failed=false)

to delete a database

db.query("DROP DATABASE DB_NEW;",function(data,err){ 
    console.log(data); 
});

Result:

return value (success=true) (Failed=false)

MiraQuery : LIST

LIST DATABASE;

LIST TABLE <DATABASE_NAME>;

Example Usage

to delete a table

db.query("LIST TABLE PERSON;",function(data,err){ 
    console.log(data); 
});

Result:

return value (success=true) (Failed=false)

to delete a database

db.query("LIST DATABASE;",function(data,err){ 
    console.log(data); 
});

Result:

return value (success=true) (Failed=false)

Example Client Source Codes (C#,Js,Java,etc..)

Example Client Source Codes

EXAMPLE CLIENT - NODEJS

first, install dependencies in your local node_modules folder

npm install request

test.js


    //MIRA-DB NODEJS CLIENT
    //Connector
    const MiraDB = require("./nodejs_express_connector");
    //Miradb object
    var db = new MiraDB("root","","http://localhost:8123/query","test");   
    //MiraQuery   
    db.query("select table test",function(data,err){
        console.log(data);
    });

Download JS Connector Download Source [Archive]

EXAMPLE CLIENT - UNITY GAME ENGINE

test.cs


    using System.Collections;
    using System.Collections.Generic;
    using UnityEngine;
    using MIRA;
        
public class test : MonoBehaviour {
        
    // Use this for initialization
        void Start () {
    //CALL DLL
        MIRA.database db = new MIRA.database();
    //SET CONF
        db.User = "root";
        db.Password = "";
        db.Database = "test";
        db.Server = "http://localhost:8123/query";
    //RETURN DATA
        string result = db.Query("select table person");
    //SHOW DATA
        Debug.Log(result);
        }
        
    // Update is called once per frame
        void Update () {    
        }
}

Download DLL Connector Download Source [unitypackage]

Unity JSON Serialization

https://docs.unity3d.com/Manual/JSONSerialization.html

EXAMPLE CLIENT - C#

Form1.cs


    namespace WindowsFormsApplication1 {
        public partial class Form1 : Form
    {
        
    public Form1() {
        InitializeComponent();
    }
                
    private void button1_Click(object sender, EventArgs e) {

    MIRA.database db = new MIRA.database(); // MIRA.DLL
        db.User = "root"; //USER NAME
        db.Password = ""; //USER PASSWORD
        db.Database = "test"; //DATABASE NAME
        db.Server = "http://localhost:8123/query"; //DB SERVER ADRESS
                
        String result = db.Query("select table person"); //QUERY
                
            if (result != "Connection Error!") {
                ArrayList data = db.row(result);
            int count = data.Count;
                                
        //Select Row Index -> data[][]; 
            textBox1.Text += "List INDEX=2 : " +data[2]["col1"] + System.Environment.NewLine; 
        //Show total record count 
            textBox1.Text += "TOTAL RECORD : (" + count +")" + System.Environment.NewLine;
                
            foreach (dynamic value in data) {
        //List All Rows -> value[]
            textBox1.Text += value["col1"] + value["col2"] + value["col3"] + System.Environment.NewLine;
            }
                } else {
                    MessageBox.Show("Remote Database server Offline", "Err");
                }       
            }
        }
    }

Download DLL Connector Download Source [Archive]

EXAMPLE CLIENT - PYTHON

INSTALL plugin "requests"

pip install requests

example.py


    import requests
    res = requests.post(
        "http://localhost:8123/query", 
        data={'user': 'root', 'pass': '', 'db': 'test','query':'select table person'}
    )
    print(res.text)

Download Source [Archive]

requests:
http://docs.python-requests.org/en/latest/user/install/#install

EXAMPLE CLIENT - PHP

test.php


<?php
    include 'miradb_php_connector.php';
        $db = new MiraDB("root","","http://localhost:8123/query","test");
            echo  $db->query("select table person");
?>

Download PHP Connector Download Source [Archive]

EXAMPLE CLIENT - JAVA

test.java


    /*Client Examples*/
    import  org.mira.database.db;
	db Conn = new db();
		Conn.user="root";
		Conn.password="";
		Conn.host="http://localhost:8123/query";
		Conn.database="test";
		   
	String result = Conn.Query("select table person");
    System.out.println( result );

Download JAVA Connector Download Source [Archive]

JSON PARSER ->
https://mvnrepository.com/artifact/com.googlecode.json-simple/json-simple

EXAMPLE CLIENT - JQUERY / HTML

test.html


<!DOCTYPE html>
<html>
<head>
<title>MIRADB</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script src="../../../CONNECTOR/Express/miradb.express.1.0.1.js"></script>
<script>
$(document).ready(function(){
 var db = new MiraDB("root","","http://localhost:8123/query","test");
 
    $("input").keypress(function(e){
        if (e.which == 13) {
	    var txt = $("input").val();	
		db.query(txt,function(result){
		   $("span").text(  JSON.stringify(result)   );
		}); 
	}
    });
});
</script>
</head>
<body>

<p>Start typing a query in the input field below (Press ENTER)</p>
QUERY:

<input type="text" size="100" value="select table person">

<p>RESULT: <span></span></p>

</body>
</html>

Download JS Connector Download Source [Archive]

EXAMPLE CLIENT - AUTOIT

test.au3


        #include './lib/WinHttp.au3'
        #include "./lib/json.au3"
            $sU = "root"
            $sP =""
            $sD="test"
            $sH="http://localhost:8123/query"
        Func Query($sQuery)
            Global $result = HttpPost( $sH ,"user=" & $sU & "&pass=" & $sP & "&db=" & $sD & "&query=" & $sQuery )
            Return $result
        EndFunc
            $o = Query("select table person") 
            $object = json_decode($o)
        MsgBox(35, "CONNECT MIRA-DB",  " JSON : " &   $o  )
        MsgBox(35, "CONNECT MIRA-DB", " Record Row 1 -> " & Json_ObjGet($object[0], "col1") )

Download Source [Archive]

Simple Web Admin

Simple admin database management tool that allows you to manage databases, tables, columns, indexes, and more from a web-based user interface.

PUBLIC HTTP :
http://localhost:8123/

INSTALL - LINUX


cd /home/miradb/public
sudo wget https://github.com/Nodeclient/Mira-DB/releases/download/webadmin/public_web_admin_102.tar.gz
sudo tar xvzf public_web_admin_102.tar.gz
sudo rm public_web_admin_102.tar.gz

INSTALL - WINDOWS


DOWNLOAD 	: public_web_admin_102.tar.gz
COPY/UNZIP  : c:/miradb/public

Download - public_web_admin.tar.gz

Download Releases

Windows and Linux Downloads

Linux Downloads

MAC Downloads

ARM Downloads

Installation

Installing on Linux (Executable)

x64 - Linux distributions

Terminal Command

x86 - Linux distributions

Terminal Command

Debian-based Linux distributions

ARCH-INSTALL-x64

Terminal Command

DEBIAN Linux distributions

DEB-INSTALL-x64

Terminal Command

Installing Npm Package (open-source)

Example : Local Database

Example : Express Remote Database

Create The Following Files

Create The Following Folders

MIRA-DB configuration manual

MiraQuery Guide ( Usage , Example , etc..)

Useful Tip:

MiraQuery : UNIQUE

Example Usage

MiraQuery : SELECT

Example Usage

Result:

Result:

Result:

Result:

Result:

Result:

MiraQuery : UPDATE

Example Usage

Result:

MiraQuery : ADD

Example Usage

Result:

Result:

MiraQuery : RENAME

Example Usage

Result:

Result:

Result:

MiraQuery : DELETE

Example Usage

Result:

Result:

Result:

MiraQuery : CREATE

Example Usage

Result:

Result:

MiraQuery : DROP

Example Usage

Result:

Result:

MiraQuery : LIST

Example Usage

Result:

Result:

Example Client Source Codes (C#,Js,Java,etc..)

Example Client Source Codes

EXAMPLE CLIENT - NODEJS

EXAMPLE CLIENT - UNITY GAME ENGINE

Unity JSON Serialization

EXAMPLE CLIENT - C#

EXAMPLE CLIENT - PYTHON

EXAMPLE CLIENT - PHP

EXAMPLE CLIENT - JAVA

EXAMPLE CLIENT - JQUERY / HTML

EXAMPLE CLIENT - AUTOIT

Simple Web Admin

INSTALL - LINUX

INSTALL - WINDOWS

INTERFACE (SCREEN)

#Help Desk