specla-database

Specla database

This module is the database handler for the Specla Framework, its like Laravels Eloquent but just for javascript and MongoDB.

Setup

To install specla-database all you have to do is to download it via npm.

npm install specla-database --save

let Database = require('specla-database');

const DB = new Database({
  driver: 'mongo',
  host: '127.0.0.1',
  port: 27017,
  database: 'MyDB'
});

Usage

Specla database includes two modules the Query builder and the DB.Model.

Query builder

Fetch data

DB.collection('users').get((err, result) => {
  // Return all users at once
});

Stream data

DB.collection('users').stream((user) => {
  // do something with the data
  return user;
}).done((result) => {
  // returns the streamed data in an array
});

Validate against schema

let schema = {
  name: String,
  age: Number,
  address: {
    city: String,
  },
  skills: Array,
  admin: Boolean,
};

let data = {
  name: 'Frederik',
  age: 22,
  address: {
    city: 'Odense',
  },
  skills: ['Javascript'],
  admin: true
};

DB.collection('users')
  .schema(schema)
  .insert(data, (err, result) => {
    // do something when the operation is completed
  });

Wheres

DB.collection('users')
  .where('name', 'John')
  .get((err, result) => {
    // do something with the data
  });

It's also possible to just parse an object to the where() like below

.where({ name: 'John' })

Sort

.sort('name', 'ASC')

Skip and limit

.skip(5)
.limit(10)

Insert

let data = {
  name: 'John',
};

DB.collection('users')
  .insert(data, (err, result) => {
    // Do something after data is inserted
  });

Update

let data = {
  name: 'John',
};

DB.collection('users')
  .where('_id', '5748aa5d45af47fc9909310b')
  .update(data, (err, result) => {
    // Do something after data is updated
  });

Remove

DB.collection('users')
  .where('_id', '5748aa5d45af47fc9909310b')
  .remove((err, result) => {
    // Do something after data is removed
  });

Raw

If there is some Mongo functionality which isn't supported yet in this module, you can then use the raw method and have full access to the Mongo object.

Its important to notice when youre using the raw method, you have to manually close the db connection with the done callback

DB.raw((db, done) => {
  var cursor = db.collection('users').find({});

  cursor.each((err, doc) => {
    if(doc !== null){
      console.log(doc);
    } else {
      done(); // CLOSE CONNECTION!!!!
    }
  });
})

Models

// the simplest model you can create
class User extends DB.Model {

  collection(){
    return 'users';
  }

  // the schema is optional
  schema(){
    return {
      name: String,
      age: Number
    };
  }

}

Create

let user = new User;
user.set('name', 'John');
user.save(() => {
  // do something when your user is created
  console.log(user.get('_id'));
});

Find

User.find('5748aa5d45af47fc9909310b', (err, user) => {
  // do something with the user
});

Update

User.find('5748aa5d45af47fc9909310b', (err, user) => {
  user.set('name', 'Frederik');
  user.save(() => {
    // do something
  });
});

delete

User.find('5748aa5d45af47fc9909310b', (err, user) => {
  user.delete(() => {
    // do something
  });
});

TODO

• Validation
  • Dates?
• Mongo
  • Advanced wheres
  • Agregates
  • Joins
  • Model events
• Mysql(maybe later)