Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fabrix-app/spool-sequelize

Spool: Sequelize ORM for Fabrix
https://github.com/fabrix-app/spool-sequelize

fabrix mysql orm postgres sequelize spool spools

Last synced: 2 months ago
JSON representation

Spool: Sequelize ORM for Fabrix

Awesome Lists containing this project

README 

        
# spool-sequelize



[![Gitter][gitter-image]][gitter-url]

[![NPM version][npm-image]][npm-url]

[![Build Status][ci-image]][ci-url]

[![Test Coverage][coverage-image]][coverage-url]

[![Dependency Status][daviddm-image]][daviddm-url]

[![Follow @FabrixApp on Twitter][twitter-image]][twitter-url]



Loads Application Models (in `api/models`) into the Sequelize ORM; Integrates with [spool-router](https://github.com/fabrix-app/spool-router) to

generate Tapestries for routes.



## Install

```sh

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

```



## Usage

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



### Configure



```js

// config/main.ts

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

export const main = {

  // ...

  spools: [

    SequelizeSpool

  ]

}

```



A basic `config/store.ts` can be found here : https://github.com/fabrix-app/spool-sequelize/blob/master/archetype/config/stores.ts



A basic `config/models.ts` can be found here : https://github.com/fabrix-app/spool-sequelize/blob/master/archetype/config/models.ts



But generally, you can configure Sequelize similiarly to this:



```js



// config/stores.ts

export const stores = {

  myStoreName: {

    orm: 'sequelize', // <-- This is the property that spool-sequelize looks for when building connections 

    // ... General Sequelize Configuration from the library's documentation

  },

  // ... Other Store configurations

}



```



### Plugins

There are 2 ways to define a plugin for Sequelize in spool-sequelize, for all sequelize connections or just for a particular one:



1) Define `plugins` in `config.sequelize`

```js

// config/sequelize.ts

export const sequelize = {

  plugins: {

    my_global_plugin: require('sequelize-plugin-name')

  }

}

```



2) Define a plugins just for a particular store connection

```js

// config/stores.ts

export const stores = {

  uristore: {

    migrate: 'drop',

    orm: 'sequelize',

    uri: 'sqlite://testuser:password@testhost:1234/testdb',

    plugins: {

      my_local_plugin: require('sequelize-plugin-name')

    }

  }

}

```



### Models



```js

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



```js

// 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:

```js

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



export class CustomerResolver extends SequelizeResolver {

  findHappy(options = {}) {

    this.findAll({ where: { happy: true} }, options)

  }

}



// NOTE: make sure to set CustomerResolver as the resolver on your Fabrix Model!

```

Now you can use it.

```js

User.findHappy()

.then(happy => {

  this.app.log.info('This many users are happy', happy.length)

})

```



For more information about sequelize queries, please look at [the official documentation](http://docs.sequelizejs.com/en/latest/docs/querying/)



## 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](https://github.com/fabrix-app/fabrix/blob/master/CONTRIBUTING.md) for more

information on how our projects are organized and how to get started.



### Release Instructions

When the master is tagged with a release, it will automatically publish to npm, updates the Changelog and bumps the version. Fabrix uses the [standard-version library](https://www.npmjs.com/package/standard-version) to manage it all.



To run a patch release: 

```bash

npm run release -- --release-as patch

``` 

and then commit to master. `git push --follow-tags origin master`



You can also test the release by running

```bash

npm run release -- --dry-run --release-as patch

``` 



## License

[MIT](https://github.com/fabrix-app/spool-sequelize/blob/master/LICENSE)



## Changelog

[Changelog](https://github.com/fabrix-app/spool-sequelize/blob/master/CHANGELOG.md)



[npm-image]: https://img.shields.io/npm/v/@fabrix/spool-sequelize.svg?style=flat-square

[npm-url]: https://npmjs.org/package/@fabrix/spool-sequelize

[ci-image]: https://img.shields.io/circleci/project/github/fabrix-app/spool-sequelize/master.svg

[ci-url]: https://circleci.com/gh/fabrix-app/spool-sequelize/tree/master

[daviddm-image]: http://img.shields.io/david/fabrix-app/spool-sequelize.svg?style=flat-square

[daviddm-url]: https://david-dm.org/fabrix-app/spool-sequelize

[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square

[gitter-url]: https://gitter.im/fabrix-app/Lobby

[twitter-image]: https://img.shields.io/twitter/follow/FabrixApp.svg?style=social

[twitter-url]: https://twitter.com/FabrixApp

[coverage-image]: https://img.shields.io/codeclimate/coverage/github/fabrix-app/spool-sequelize.svg?style=flat-square

[coverage-url]: https://codeclimate.com/github/fabrix-app/spool-sequelize/coverage