Grand Central Records (GCR)


A promise-based Node ORM/ActiveRecord library that can connect to MySQL, Postgres, and SQLite3. Allows chainable, raw or queueable queries.

---------------------------------------

Getting started

$3

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

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

Model.find(8).then(function(users) {
console.log(users[0].name);
}).catch(console.error);

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

Creating a new instance of the GCR object creates a connection to a new database.

* __connection__ object — Database connection parameters.
adapter* — mysql/MySQL, postgresql/postgres/pg, sqlite3/sqlite
host, database, username, password* — connection parameters
* __table__ string — An optional table name if only a single table is being queried.
* __options__ object — Options to pass to the model.
verbose* boolean function — Turning verbose on will log all queries to the console. false by default. If a function is provided, it will be used to log all outputs.
idAttribute* string — The name of the unique ID attribute field (defaults to 'id').
* (see Models)

$3

* __table__ string — The name of the table the model is associated with.
* __options__ json — See above.

Multiple models can also be created from the same database.

`js
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");
``

---------------------------------------

Documentation

$3

* GCR()
* model()

$3

* query()
* queue()

$3

* Models
* Validations
* Creating & Updating Models
* Expansion of models
* reload()

$3

* setTable
* addGetter
* addMethod
* addQueryMethod
* Promise aliases
- parallel
- thenOne
- thenEach
- thenMap

$3

* all()
* find()
* where()
* select()
* order()
* limit()
* offset()
* insert()
* update()
* remove()

#### Postgres

* end()
* Query: returning()
* Data type: Array
* Data type: hstore

---------------------------------------

$3

* JugglingDB
* Node-ORM
* Model
* Persist
* Mongoose