MySQL storage plugin and persistence layer for Modella.
npm install modella-mysql
MySQL persistence layer for Modella.
``sh`
npm install modella-mysql
`javascript
var modella = require('modella');
var mysql = require('modella-mysql');
var User = modella('User');
User.use(mysql({
database: 'mydb',
user: 'root'
});
`
Create a new Modella plugin with the given database settings and options.
settings same as settings for
node-mysql
options
* The table for this model. Defaults to singularized model name.maxLimit
* The maximum number of records to select at once. Default is 200.
Get all models using given query.
`javascript`
User.find({ where: { city: 'San Francisco' }}, function(err, result) {
console.log(result);
// => { data: [...], limit: 50, offset: 0, total: 43834 }
});
The callback result is an object with the following properties:
data array of found models limit maximum number of models returned (page size) offset offset for pagination total total number of models found with query
The limit, offset, and total properties are used in building pagination.
Find a model by given id or query.
`javascript
User.find(5, function(err, user) {
user.name(); // => Alex
});
User.find({ where: { name: 'Alex' }}, function(err, user) {
user.name(); // => Alex
});
`
Find models using given query.
`javascript`
User.all({ $gt: { created_at: lastWeek} }, function(err, users) {
// ...
});
The users object looks like:
`json`
{
"total": 32443,
"limit": 50,
"offset": 0,
"data": [user, user, ...]
}
Define a "has many" relationship with given name and params.
`javascript
User.hasMany('posts', { model: Post, foreignKey: 'user_id' });
// Creates methods:
user.posts(function(err, posts) {
// ...
})
var post = user.posts.create();
`
Define a "belongs to" relationship with given Model.
`javascript
User.belongsTo(Post, { as: 'author', foreignKey: 'user_id' });
// Creates method:
post.author(function(err, user) {
// ...
});
`
Define a "has and belongs to many" relationship with given name and params.
`javascript
User.hasAndBelongsToMany(Post, {
as: 'posts',
through: PostUser,
fromKey: 'user_id',
toKey: 'post_id'
});
// Creates methods:
user.posts(function(err, posts) {
// ...
})
var post = user.posts.create();
post.author(function(err, user) {
// ...
});
`
Any model with a "has many" relationship can be included in the results for
Model.all() and Model.get() by specifying the name of the relationship in the
req.query.include parameter. Related models will be added to model.related.
`javascript`
User.find({ id: 1, include: 'posts' }, function(err, user) {
console.log(user.related.posts);
// => will contain the post models related to this user.
});
`javascript
User.on('mysql before save', function(model, attrs) {
// ...
});
user.on('mysql before save', function(attrs) {
// ...
});
`
`javascript
User.on('mysql after save', function(model) {
// ...
});
user.on('mysql after save', function() {
// ...
});
`
`javascript
User.on('mysql before update', function(model) {
// ...
});
user.on('mysql before update', function() {
// ...
});
`
`javascript
User.on('mysql after update', function(model) {
// ...
});
user.on('mysql after update', function() {
// ...
});
`
`javascript
User.on('mysql before remove', function(model) {
// ...
});
user.on('mysql before remove', function() {
// ...
});
`
`javascript
User.on('mysql after remove', function(model) {
// ...
});
user.on('mysql after remove', function() {
// ...
});
`
MySQL module.
Models that share a settings object will share a connection pool, exposed via
settings.pool.
The query is a subset of mongo-sql.
The type, columns, and table properties are handled by modella-mysql.
Custom table names are specified using the tableName option. For example:
`javascript`
User.use(mysql({
database: 'mydb',
user: 'root'
}, {
tableName: 'users'
}));
Custom field names are provided by a columnName property in the attribute
definition. For example:
`javascript`
User
.attr('id')
.attr('firstName', {
type: 'string',
length: 255,
columnName: 'first_name'
})
.attr('lastName', {
type: 'string',
length: 255,
columnName: 'last_name'
});
Attributes with type: "date" will be handled based on the columnType
property. This property can either be "datetime", "timestamp", or "integer",
corresponding to MySQL column type.
If you need to control exactly how a data-type is determined, set the attribute
definition's dataFormatter function:
`javascript
var Event = modella('Event');
Event.attr('date', { dataFormatter: function(value, Event) {
value = Math.floor(value.getTime() / 1000);
return value;
});
`
Tests are written with mocha and
should using BDD-style assertions.
Tests require an accessible MySQL server. Configure the database using the
following set of environment variables:
`sh`
export NODE_TEST_MYSQL_HOST="127.0.0.1"
export NODE_TEST_MYSQL_USER="root"
export NODE_TEST_MYSQL_PASSWORD=""
export NODE_TEST_MYSQL_PORT=3306
Run the tests with npm:
`sh``
npm test