Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
orm-model
Advanced tools
Readme
ORM libraries are great but they usually left you with a gigantic and unstructured block of code. You have to manually figure the right way on how to split the code into multiple files and it gets event worse when you have multiple databases or even multiple ORMs.
This module brings unified MVC-style structure for models into your NodeJS project. Currently the mongoose and sequelize ORMs are supported.
Install the npm package.
npm install orm-model --save
Let's first configure project's database connectors (connections). By default the module will try to read the config/connectors.js
configuration file so let's create it. The file content should look like the example bellow.
// config/connectors.js
module.exports = {
default: {
// mongoose database connector
'mongo-db': {
orm: 'mongoose',
uris: 'mongodb://user:secret@hostname:port/database',
options: {}
},
// sequelize database connector
'seq-db': {
orm: 'sequelize',
database: 'database',
username: 'root',
password: 'secret',
options: {}
}
},
production: {}
};
The next step is to define models. The module will load files found at app/models
. Let's create two models for mongo-db
connector and two models for seq-db
connector (defined earlier).
// app/models/animal.js (mongoose model)
module.exports = {
connector: 'mongo-db',
attributes: {
name: 'string'
},
classMethods: {},
instanceMethods: {},
plugins: [],
middleware: {},
options: {}
};
// app/models/bird.js (mongoose discriminator of animal)
module.exports = {
connector: 'mongo-db',
extends: 'animal'
};
// app/models/user.js (sequelize model)
module.exports = {
connector: 'seq-db',
attributes: {
name: 'STRING'
},
options: {
classMethods: {},
instanceMethods: {}
}
};
// app/models/friend.js (sequelize model extends from user)
module.exports = {
connector: 'seq-db',
extends: 'user'
};
Now we only have to load and connect connectors and models together to make it work. We do this inside project's main file (e.g. index.js
).
var orm = require('../orm-model');
orm.connect({
connectorsPath: 'new/file/path.js', // optional
modelsPath: 'new/directory/path' // optional
});
After the project has been setup we can access any model like this:
var orm = require('orm-model');
var Bird = orm.model('bird');
Bird.create({ name: "Fluppy" }, function(err, data) {
console.log('Mongoose Fluppy bird created.');
});
You can also access an instance of a connector (database connection).
var orm = require('orm-model');
var sequelize = orm.connection('seq-db');
sequelize.query("SELECT * FROM users").success(function(data) {
console.log('Sequelize results:', data);
});
FAQs
Unified MVC-style structure for ORM models.
We found that orm-model demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).