grand-central-records

Grand Central Records

A basic ORM/ActiveRecord library for use in smaller Node projects or frameworks. Work in progress.

TODO

• Finish tests
• Create object for Model.new() & .save()
• Model getters (replace row values)
• Model methods
• .getColumns()
• MySQL Pool Connections
• Model validations
• Separate multiple queries for PG (like MySQL)
• Migration / synchronization
• MongoDB integration

Custom ORM

• Connects with
  • MySQL
  • Postgres
  • SQLite3
• Chainable queries
• Other functions/aliases
  • .findByIdAndUpdate()
  • .findByIdAndRemove()
  • .create()
• Raw queries
  • .query() (on SQL databases) -- executes the given query
  • .queue(query string or chain) (accepts array, string, object)
  • .run() -- executes all queries in the queue

Inspiration

• JugglingDB
• Node-ORM
• Model
• Persist
• Mongoose

Documentation

Samples:

var GCR = require('grand-central-records');

var Model = new GCR({
    adapter: "mysql",
    host: "localhost",
    database: "test",
    username: "admin",
    password: "admin"
}, "users");

Model.find(8, function(err, user){
    if (err) throw err;
    console.log(user.name);
});

Model.select(["name","address"]).where({admin: true}, function(err, result) {
    if (err) throw err;
    result.forEach(function(user) {
        ...
    });
});

Multiple models can also be created from the same database.

var GCR = require('grand-central-records');

var db = new GCR({
    adapter: "mysql",
    host: "localhost",
    database: "test",
    username: "admin",
    password: "admin"
}, { verbose: true });

var User = db.model("users"),
    Project = db.model("projects");

Raq Queries

.query(query, [values], callback)

Execute raw query to database.

db.query('SELECT 1', function(err, res) {
    console.log(res[0]); // 1
});

// Substitute with array of values
db.query('SELECT 1; SELECT %2;', ['hello'], function(err, res) {
    console.log(res[0]); // 1
    console.log(res[1]); // hello
});

// Substitute with key/values
db.query('SELECT :name', { name: 'hello' }, function(err, res) {
    console.log(res[0]); // hello
})

.queue(query, [values])

Add query to queue for layer execution.

db.queue('SELECT 1')
  .queue('SELECT %1', [2])
  .queue('SELECT :name', { name: 'hello' })
  .run(function(err, res) {
    console.log(res[0]); // 1
    console.log(res[2]); // hello
});

db.queue('SELECT 1');
. . .
db.run(function(err, res) {
    console.log(res[0]); // 1
});

Query Methods:

.all()

.find()

.where()

.select()

.order()

.limit()

.offset()

.insert()

.update()

.remove()