|
|
|
|
|
<p align="center">
|
|
|
|
|
|
<img src="logo.svg" width="100" alt="Sequelize logo" />
|
|
|
|
|
|
<h1 align="center"><a href="https://sequelize.org">Sequelize</a></h1>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.npmjs.com/package/sequelize)
|
|
|
|
|
|
[](https://github.com/sequelize/sequelize/actions?query=workflow%3ACI)
|
|
|
|
|
|
[](https://www.npmjs.com/package/sequelize)
|
|
|
|
|
|
[](https://github.com/sequelize/sequelize/graphs/contributors)
|
|
|
|
|
|
[](https://opencollective.com/sequelize#section-contributors)
|
|
|
|
|
|
[](https://opencollective.com/sequelize)
|
|
|
|
|
|
[](https://github.com/sequelize/sequelize)
|
|
|
|
|
|
[](https://github.com/semantic-release/semantic-release)
|
|
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
|
|
|
|
|
|
|
|
Sequelize is an easy-to-use and promise-based [Node.js](https://nodejs.org/en/about/) [ORM tool](https://en.wikipedia.org/wiki/Object-relational_mapping) for [Postgres](https://en.wikipedia.org/wiki/PostgreSQL), [MySQL](https://en.wikipedia.org/wiki/MySQL), [MariaDB](https://en.wikipedia.org/wiki/MariaDB), [SQLite](https://en.wikipedia.org/wiki/SQLite), [DB2](https://en.wikipedia.org/wiki/IBM_Db2_Family), [Microsoft SQL Server](https://en.wikipedia.org/wiki/Microsoft_SQL_Server), and [Snowflake](https://www.snowflake.com/). It features solid transaction support, relations, eager and lazy loading, read replication and more.
|
|
|
|
|
|
|
|
|
|
|
|
Would you like to contribute? Read [our contribution guidelines](https://github.com/sequelize/sequelize/blob/main/CONTRIBUTING.md) to know more. There are many ways to help! 😃
|
|
|
|
|
|
|
|
|
|
|
|
## :computer: Getting Started
|
|
|
|
|
|
|
|
|
|
|
|
Ready to start using Sequelize? Head to [sequelize.org](https://sequelize.org) to begin!
|
|
|
|
|
|
|
|
|
|
|
|
- [Our Getting Started guide for Sequelize 6 (stable)](https://sequelize.org/docs/v6/getting-started)
|
|
|
|
|
|
|
|
|
|
|
|
## :money_with_wings: Supporting the project
|
|
|
|
|
|
|
|
|
|
|
|
Do you like Sequelize and would like to give back to the engineering team behind it?
|
|
|
|
|
|
|
|
|
|
|
|
We have recently created an [OpenCollective based money pool](https://opencollective.com/sequelize) which is shared amongst all core maintainers based on their contributions. Every support is wholeheartedly welcome. ❤️
|
|
|
|
|
|
|
|
|
|
|
|
## :pencil: Major version changelog
|
|
|
|
|
|
|
|
|
|
|
|
Please find upgrade information to major versions here:
|
|
|
|
|
|
|
|
|
|
|
|
- [Upgrade from v5 to v6](https://sequelize.org/docs/v6/other-topics/upgrade-to-v6)
|
|
|
|
|
|
|
|
|
|
|
|
## :book: Resources
|
|
|
|
|
|
|
|
|
|
|
|
- [Documentation](https://sequelize.org)
|
|
|
|
|
|
- [Databases Compatibility Table](https://sequelize.org/releases/)
|
|
|
|
|
|
- [Changelog](https://github.com/sequelize/sequelize/releases)
|
|
|
|
|
|
- [Discussions](https://github.com/sequelize/sequelize/discussions)
|
|
|
|
|
|
- [Slack](https://join.slack.com/t/sequelize/shared_invite/zt-1igt9hx8h-tGWU4AI1bRPvkRdEK5wnuQ)
|
|
|
|
|
|
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sequelize.js)
|
|
|
|
|
|
|
|
|
|
|
|
### :wrench: Tools
|
|
|
|
|
|
|
|
|
|
|
|
- [CLI](https://github.com/sequelize/cli)
|
|
|
|
|
|
- [With TypeScript](https://sequelize.org/docs/v6/other-topics/typescript)
|
|
|
|
|
|
- [Enhanced TypeScript with decorators](https://github.com/RobinBuschmann/sequelize-typescript)
|
|
|
|
|
|
- [For GraphQL](https://github.com/mickhansen/graphql-sequelize)
|
|
|
|
|
|
- [For CockroachDB](https://github.com/cockroachdb/sequelize-cockroachdb)
|
|
|
|
|
|
- [Awesome Sequelize](https://sequelize.org/docs/v6/other-topics/resources/)
|
|
|
|
|
|
- [For YugabyteDB](https://github.com/yugabyte/sequelize-yugabytedb)
|
|
|
|
|
|
|
|
|
|
|
|
### :speech_balloon: Translations
|
|
|
|
|
|
|
|
|
|
|
|
- [English](https://sequelize.org) (Official)
|
|
|
|
|
|
- [中文文档](https://github.com/demopark/sequelize-docs-Zh-CN) (Unofficial)
|
|
|
|
|
|
|
|
|
|
|
|
## :warning: Responsible disclosure
|
|
|
|
|
|
|
|
|
|
|
|
If you have security issues to report, please refer to our
|
|
|
|
|
|
[Responsible Disclosure Policy](https://github.com/sequelize/sequelize/blob/main/SECURITY.md) for more details.
|
