MichiJDB ORM !

MichiJDB ORM is a javascript ORM for creating database in JSON files.

Installation

1 - Install module

$ npm install michi-jdb

2 - Generate MichiJDB Folder Structure

$ michi-jdb generate-structure 

.								# Your project
├── ...
├── app
│   └── michiJDB
│       ├── Entity 				# Entity Folder
│   	└── entityList.js 		# List of all entity in Entity Folder
└── ...

3 - Generate your entity

$ michi-jdb orm generate-entity  # Execute this command for generate Entity

$ *** Generate new entity ***

$ Entity Name : User

$ Entity Index Name : username

$ Entity Index Name : email

$ Entity Index Name : phone

$ The Entity User was generated

Entity Exemple

const michiJDB = require('michi-jdb');

class User{

	constructor(){
		this.id = michiJDB.Mapping.Id(User.name);
		this.objectName = User.name;
	}

	getUsername(){
		return this.username;
	}

	setUsername(username){
		this.username = username;
	}

	getEmail(){
		return this.email;
	}

	setEmail(email){
		this.email = email;
	}

	getPhone(){
		return this.phone;
	}

	setPhone(phone){
		this.phone = phone;
	}

}

module.exports = User;

Usage

Create Object and save in json file

const michiJDB = require('michi-jdb');
const User = require('./app/michiJDB/Entity/User.js');

var user = new User(); 								# Create User object
user.setUsername('username');
user.setEmail('[email protected]');
user.setPhone('0000000');

michiJDB.EntityManager.persistEntity(user); 		# Persist Object for add
michiJDB.EntityManager.flushEntity(); 				# Add User object in database (JSON files)

Get objects

var repositoryUser = michiJDB.EntityManager.getRepository('User'); 					# Get User Repository
var user = repositoryUser.findById(1); 												# Get User by ID
var userList = repositoryUser.findAll(); 											# Find all User in database
var userListByUsername = repositoryTestEntity.findBy({username:'username'}); 		# Get all user where username = 'username'
var userByUsername = repositoryTestEntity.findOneBy({username:'username'}); 		# Get one user where username = 'username'

Remove object from database

var repositoryUser = michiJDB.EntityManager.getRepository('User'); 					# Get User Repository
var user = repositoryUser.findById(1); 												# Get User by ID
michiJDB.EntityManager.removeEntity(user);											# Persist Object for remove
michiJDB.EntityManager.flushEntity();												# Remove User object in database (JSON files)

License

MIT