spool-sequelize

Loads Application Models (in api/models) into the Sequelize ORM; Integrates with spool-router to generate Tapestries for routes.

Install

$ npm install @fabrix/spool-sequelize --save

Usage

Sequelize is a SQL orm and this spool uses that to add power to Fabrix models.

Configure

// config/main.js
module.exports = {
  // ...
  spools: [
    require('@fabrix/spool-sequelize').SequelizeSpool
  ]
}

A basic config/store.js can be found here : https://github.com/fabrix-app/spool-sequelize/blob/master/lib/archetype/config/database.js

Models

import { FabrixModel as Model } from '@fabrix/fabrix/dist/common'
import { SequelizeResolver } from '@fabrix/spool-sequelize'

export class User extends Model {
  // More about supported schema here : http://docs.sequelizejs.com/en/latest/docs/models-definition/
  static schema (app, Sequelize) {
    return {
       name: { type: Sequelize.STRING, allowNull: false },
       password: Sequelize.STRING,
       displayName: Sequelize.STRING
     }
  }

  static config (app, Sequelize) {
    return {
       migrate: 'drop', //override default models configurations if needed
       store: 'sqlite', //override default models configurations if needed
       // More informations about supported models options here : http://docs.sequelizejs.com/en/latest/docs/models-definition/#configuration
       options: {}
     }
  }
  
  // The Way this model interacts with Sequelize
  static get resolver () {
    return SequelizeResolver
  }
  
  // If you need associations, put them here
  static associate(models) {
     // More information about associations here : http://docs.sequelizejs.com/en/latest/docs/associations/
     models.User.hasMany(models.Role, {
       as: 'roles',
       onDelete: 'CASCADE',
       foreignKey: {
         allowNull: true
       }
     })
  }
}

Query

// api/services/UserService.js
export class UserService extends Service {
  /**
   * Finds people with the given email.
   * @return Promise
   * @example {
   *    name: 'Ludwig Beethoven',
   *    email: '[email protected]',
   *    favoriteColors: [
   *      { name: 'yellow', hex: 'ffff00' },
   *      { name: 'black', hex: '000000' }
   *     ]
   * }
   */
  findUser (email) {
    //More info about queries here : http://docs.sequelizejs.com/en/latest/docs/models-usage/
    return this.app.models.User.find({ where: {email: email} })
  }
}

Resolvers

You can use the SequleizeResolver to add custom resolutions to your models. For example:

import { SequelizeResolver } from '@fabrix/spool-sequelize'

export class CustomerResolver extends SequelizeResolver {
  findHappy(options = {}) {
    this.findAll({ where: { happy: true} }, options)
  }
}

Now you can use it.

User.findHappy()
.then(happy => {
  this.app.log.info('This many users are happy', happy.length)
})

For more informations about sequelize queries, please look at the official documentation

Tapestries query options

Some options can be provide as query param for the find method, example GET /api/v1/user.

Populate

You can add /api/v1/user?populate=all to populate all associations or use /api/v1/user?populate=field1,field2 to populate only some association.

Pagination

By settings offset and limit you can do some pagination, example /api/v1/user?offset=10&limit=10 will return only 10 items started from 10 (id 10 to 20).

Contributing

We love contributions! Please check out our Contributor's Guide for more information on how our projects are organized and how to get started.

License

MIT

Changelog

Changelog