hapi-sequelize: A JavaScript repository from KristenGarnier

hapi-sequelize - A Hapi plugin for the Sequelize ORM

Installation

npm install hapi-sequelize --save

Loading the plugin

server.register(
    [
        {
            register: require('hapi-sequelize'),
            options: {
                database: 'dbName',
                user: 'root',
                pass: 'root',
                dialect: 'mysql',
                port: 8889,
                models: 'models/**/*.js',
                sequelize: {
                    define: {
                        underscoredAll: true
                    }
                }
            }
        },
    ], function(err) {
        if (err) {
            console.error('failed to load plugin');
        }
    }
);

You can also pass in a database connection URI in the events that your database connection is extracted from the codebase, like on Heroku:

server.register(
    [
        {
            register: require('hapi-sequelize'),
            options: {
                uri: process.env.DATABASE_URI,
                models: 'models/**/*.js',
                sequelize: {
                    define: {
                        underscoredAll: true
                    }
                }
            }
        },
    ], function(err) {
        if (err) {
            console.error('failed to load plugin');
        }
    }
);

Available Options

options: {
    database: 'dbName', // database name
    user: 'root',       // db username
    pass: 'root',       // db password
    dialect: 'mysql',   // database type
    host: 'localhost',  // db host
    port: 8889,         // database port #
    uri: 'postgres://user:pass@example.com:5432/dbname' // database URI
    models: ['models/**/*.js', 'other/models/*.js'],   // glob or an array of globs to directories containing your sequelize models
    logging: false      // sql query logging
    sequelize: {       // Options object passed to the Sequelize constructor http://docs.sequelizejs.com/en/latest/api/sequelize/#new-sequelizeatabase-usernamenull-passwordnull-options
        define: {
            timestamps: false
        }
    }
}

Usage

Your models are attached to the sequelize instance and will be available throughout your application via server.plugins (which is also available through the request object ie: request.server.plugins)

var models = request.server.plugins['hapi-sequelize'].db.sequelize.models;

models.User.create({
    email: 'some@email.com',
    password: 'password123'
});

Model Definitions

Exports a function that returns a model definition http://docs.sequelizejs.com/en/latest/docs/models-definition/

module.exports = function(sequelize, DataTypes) {
    var StoreOptions = sequelize.define(
        'StoreOptions',
        {
            optionName: {
                type: DataTypes.STRING,
                unique: true,
                allowNull: false
            },
            optionValue: {
                type: DataTypes.TEXT
            }
        },
        {
            tableName: 'store_config',
            timestamps: false
        }
    );

    return StoreOptions;
};

Models Association

Associating models is done through sqlizr, check out for more in depth informations. To associate models you just create an associate function in your model definition. Sqlizr will pass and Object containing all the loaded models, to avoid the hassle of requiring models. Then, within the function you build an association like you used to with sequelize.

module.exports = function(sequelize, DataTypes) {
 return sequelize.define(
   'ModelName',
   {/** model attributes **/},
   {
     classMethods: {
       associate: function(models) {
         models.ModelName.belongsTo(models.AnotherModel, options);
       }
     }
   }
 );
};

Syncing Models

Sync'ing needs to be done after the plugin has loaded (typically in the callback function where it was registered). A regular sync will CREATE TABLE IF NOT EXISTS , while a sync with the { force: true } option passed will drop all of your tables first.

var db = server.plugins['hapi-sequelize'].db;
db.sequelize.sync().then(function() {
  console.log('models synced');
});

Add Models to Hapi Request Object

To enable access to your models via the Hapi request object add the following code when creating the Hapi server

server.ext('onPreHandler', function(modelCollections) {
    return function(request, reply) {
        request.models = modelCollections;
        reply.continue();
    }
}(server.plugins['hapi-sequelize'].db.sequelize.models));

Then within a request handler you can access the models with

var dbModel = request.models.modelname;

Security

This plugin has been updated to use version 3+ of Sequelize which adds many preventative measures to help users avoid the vulnerabilities explained in the article below. Please give the article a good read to ensure that you're using Sequelize safely!

https://securityblog.redhat.com/2015/05/20/json-homoiconicity-and-database-access/

Also make sure to take a look at the changelog if you're upgrading from a pre 3+ version. There are several breaking changes that will need to be addressed.

https://github.com/sequelize/sequelize/blob/master/changelog.md

KristenGarnier/hapi-sequelize