NodeJS ORM
About
Node-ORM is a NodeJS module for multiple databases using Object-Relational Mapping.
Installing
Install using NPM:
npm install orm
Connecting to a Database (MySQL in the example)
You can check the API for a more detailed overview.
var orm = require("orm");
var db = orm.connect("mysql://username:password@hostname/database", function (success, db) {
if (!success) {
console.log("Could not connect to database!");
return;
}
// you can now use db variable to define models
});
Connecting via raw database API
var orm = require("orm");
var mysql = require("mysql");
var client = mysql.createClient({
user: 'root',
password: 'root'
});
var db = orm.connect("mysql", client, function (success, db) {
// same as above...
});
This allows you to generate your own database objects that conform to the following postgres and mysql libraries:
Defining a model
var Person = db.define("person", {
"name" : { "type": "string" },
"surname": { "type": "string", "default": "" },
"age" : { "type": "int" }
}, {
"methods" : {
"fullName" :function () {
return this.name + " " + this.surname;
}
}
});
Adding associations
Person.hasOne("father", Person);
// or just
Person.hasOne("mother"); // defaults to same model
Person.hasMany("friends", Person, "friend"); // will create a table "person_friends" with 2 fields (person_id and friend_id)
Creating the model on the database
Person.sync();
Creating and using a record
var John = new Person({
"name" : "John",
"surname" : "Doe",
"age" : 20
});
console.log("Hello, my name is " + John.fullName() + " and I'm " + John.age + " years old");
Saving record to database
John.save(function (err, JohnCopy) {
if (!err) {
console.log("Saved! ID=" + John.id); // you can use John or JohnCopy
} else {
console.log("Something went wrong...");
console.dir(err);
}
});
Changing associations
I think an example is better to explain.
John.setFather(Jeremy, function () {
John.setMother(Jane, function () {
John.addFriends(Jeremy, Jane, function () {
console.log("Jeremy and Jane (John's parents) are now his friends too");
});
});
});
If you want there's also this methods:
John.getFather(function (JohnFather) {
console.log("John's father is " + JohnFather.name);
});
John.unsetMother(function () {
console.log("John has no mother now!");
});
John.removeFriends(Jeremy, Jane, function () {
console.log("John has no friends now!");
});
// or just don't send any, all will be removed
John.removeFriends(function () {
console.log("John has no friends now!");
});
Supported Types
This values are still just supported for .sync() (table creations), not for other instance operations like .save() (yet).
Name | Description | MySQL Type | PostgreSQL Type |
---|---|---|---|
string | Small text | VARCHAR(255) | VARCHAR(255) |
text | Big text | TEXT | TEXT |
int, integer, num, number | Signed integer | INT | INTEGER |
float | Floating point number | FLOAT | REAL |
bool, boolean | True or false value | TINYINT(1) (true=1, false=0) | BOOLEAN |
date | Date/time value (seconds precision) | DATETIME | TIMESTAMP |
data | Binary data | BLOB | BYTEA |
enum | Enumerated value | ENUM | ENUM |
struct | Generic (and simple) object | TEXT (saved as JSON) | TEXT (saved as JSON) |