eggjs / sequelize

An easy-to-use multi SQL dialect ORM for Node.js

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.

Sequelize follows SEMVER. Supports Node v6 and above to use ES6 features.

New to Sequelize? Take a look at the Tutorials and Guides. You might also be interested in the API Reference.

v5 Release

You can find the upgrade guide and changelog here.

Table of Contents

• Installation
• Documentation
• Responsible disclosure
• Resources

Installation

$ npm install --save sequelize # This will install v5

# And one of the following:
$ npm install --save pg pg-hstore # Postgres
$ npm install --save mysql2
$ npm install --save mariadb
$ npm install --save sqlite3
$ npm install --save tedious # Microsoft SQL Server

Documentation

• v5 Documentation
• v4 Documentation
• v3 Documentation
• Contributing

Responsible disclosure

If you have any security issue to report, contact project maintainers privately. You can find contact information in CONTACT.md.

Resources

• Changelog
• Slack
• Stack Overflow

Tools

• Sequelize & TypeScript
• Enhanced TypeScript with decorators
• Sequelize & GraphQL
• Add-ons & Plugins
• Sequelize CLI

Learning

• Getting Started
• Express Example

Translations

• English v5 (OFFICIAL)
• 中文文档 v4/v5 (UNOFFICIAL)