https://github.com/hsynlms/sequelize-fastify

A Sequelize plugin for Fastify.
https://github.com/hsynlms/sequelize-fastify

fastify fastify-plugin mariadb mssql mysql postgresql sequelize sqlite

Last synced: 2 months ago
JSON representation

A Sequelize plugin for Fastify.

• Host: GitHub
• URL: https://github.com/hsynlms/sequelize-fastify
• Owner: hsynlms
• License: mit
• Created: 2020-06-13T11:31:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-23T21:50:29.000Z (8 months ago)
• Last Synced: 2024-05-01T13:35:51.681Z (8 months ago)
• Topics: fastify, fastify-plugin, mariadb, mssql, mysql, postgresql, sequelize, sqlite
• Language: JavaScript
• Homepage:
• Size: 106 KB
• Stars: 16
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sequelize-fastify

> A [Sequelize](https://sequelize.org/) plugin for [Fastify](https://github.com/fastify/fastify).

[![Downloads](https://img.shields.io/npm/dm/sequelize-fastify.svg)](https://npmjs.com/sequelize-fastify)

[![install size](https://packagephobia.com/badge?p=sequelize-fastify)](https://packagephobia.com/result?p=sequelize-fastify)

**Note:** Fastify v4 support is shipped with v2.0.0.

**Supported Sequelize versions:**

- v6.x

## What is Sequelize?

Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more.

Please check [official website](https://github.com/sequelize/sequelize) for more information and developer documentation.

## Installation

```

$ npm install sequelize-fastify --save

```

## Usage

```js

const sequelizeFastify = require('sequelize-fastify')

await fastify.register(

  sequelizeFastify,

  {

    instance: 'db',

    sequelizeOptions: {

      dialect: 'DIALECT_NAME', /* one of 'mysql' | 'mariadb' | 'postgres' | 'mssql' */

      database: 'DATABASE_NAME',

      username: 'DATABASE_USER_NAME',

      password: 'DATABASE_USER_PASSWORD',

      host: 'DATABASE_HOST_OR_SERVER',

      port: 'DATABASE_PORT'

    }

  }

)

  .ready(async () => {

    try {

      // first connection

      const result = await fastify.db.authenticate()

      console.log(

        chalk.green('Database connection is successfully established.')

      )

    } catch(err) {

      console.log(

        chalk.red(`Connection could not established: ${err}`)

      )

    } finally {

      fastify.close()

    }

  })

```

## Options

| Name               | Type       | Default          | Description                                                                       |

| ---                | ---        | ---              | ---                                                                               |

| instance           | string     | `sequelize`      | A decorator instance name which will be available anywhere in the fastify server. |

| sequelizeOptions   | object     | `{}`             | Sequelize configuration object which will be passed to Sequelize instance while creating. Please see [API Reference](https://sequelize.org/master/class/lib/sequelize.js~Sequelize.html#instance-constructor-constructor) doc. |