sequelize-connect

sequelize-connect

Formerly sequelize-singleton.

sequelize-connect is a simple singleton wrapper for the sequelize ORM, making it easier to configure and build models with Sequelize.

• Configuring sequelize-connect
  • Connection String
• Custom Matcher
• Accessing Sequelize
• Defining Models
• Logging
• Contributing

Configuring sequelize-connect

NOTE: sequelize-connect must be configured upon app initialization, prior to accessing your models

The sequelize-connect connect() method accepts the same parameters as the Sequelize() object database, username, password, options. It is important to configure the discover array of the set of paths where your models should be discovered.

// app.js
var orm 		= require('sequelize-connect');

orm.discover = [__dirname + '/models'];
orm.connect(
  'test-db',
  'test-user',
  'secret1234',
  {
    dialect: "mysql",
    port:    3306
  })
  .then(function(){
    // Connection is completed
  });

Upon connect() sequelize-connect will ASYNCHRONOUSLY recurse through all of the subfolders located at the provided file paths looking for any files with the naming default convention *.model.js. Connect will return a Promise that is called on it's completion.

Connection String

You can use a connection string to connect as well:

orm.connect(
  'MyConnectionString',
  {
    dialect: "mysql",
    port:    3306
  })
  .then(function(){
    // Connection is completed
  });

Custom matcher

If you prefer to define your own naming convention instead of the default you can create a custom matching function which receives the file name as the parameter returns a boolean indicating if sequelize-connect should attempt to load the file as a model.

This function should be attached to matcher like so:

orm.matcher = function(file){
  if(//some condition or regex here)
    return true;

  return false;
};

Accessing sequelize

After connecting you can access the sequelize instance and models wherever you need!

// somefile.js

var orm       = require('sequelize-connect');
var sequelize = orm.sequelize;
var Sequelize = orm.Sequelize;
var models    = orm.models;
var User      = models.User;

Defining Models

Models are defined as per the suggestion the article here: http://sequelizejs.com/articles/express. All associations are done via the class method associate which is injected with the models object.

// user.model.js

"use strict";

module.exports = function(sequelize, DataTypes) {
  var User = sequelize.define("User", {
    username: DataTypes.STRING
  }, {
    classMethods: {
      associate: function(models) {
        User.hasMany(models.Task)
      }
    }
  });

  return User;
};

Logging

Logging is done via the winston, the winston object can be accessed at via orm.logger. If you want to control the log level you can do it like so:

orm.logger.level = "debug";

To disable logging entirely:

orm.logger.level = null

Contributing

Please read the contributing guidlines

Changelog

1.2.2 (2016-04-01)

Features

• lib: Make discover property accept string or array (f5855a3)

<a name="1.2.1"></a>