76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
|
<p align="center">
|
||
|
|
<img src="docs/images/logo-small.png" width="100" />
|
||
|
|
<h1 align="center">Sequelize</h1>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
[](https://www.npmjs.com/package/sequelize)
|
||
|
|
[](https://github.com/sequelize/sequelize/actions?query=workflow%3ACI)
|
||
|
|
[](https://www.npmjs.com/package/sequelize)
|
||
|
|
[](https://opencollective.com/sequelize)
|
||
|
|
[](https://github.com/sequelize/sequelize)
|
||
|
|
[](https://github.com/semantic-release/semantic-release)
|
||
|
|
|
||
|
|
Sequelize is a 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) and [Microsoft SQL Server](https://en.wikipedia.org/wiki/Microsoft_SQL_Server). It features solid transaction support, relations, eager and lazy loading, read replication and more.
|
||
|
|
|
||
|
|
Sequelize follows [Semantic Versioning](http://semver.org) and supports Node v10 and above.
|
||
|
|
|
||
|
|
New to Sequelize? Take a look at the [Tutorials and Guides](https://sequelize.org/master). You might also be interested in the [API Reference](https://sequelize.org/master/identifiers).
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### v6 Release
|
||
|
|
|
||
|
|
You can find the detailed changelog [here](https://github.com/sequelize/sequelize/blob/main/docs/manual/other-topics/upgrade-to-v6.md).
|
||
|
|
|
||
|
|
## 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. ❤️
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ npm i sequelize # This will install v6
|
||
|
|
|
||
|
|
# And one of the following:
|
||
|
|
$ npm i pg pg-hstore # Postgres
|
||
|
|
$ npm i mysql2
|
||
|
|
$ npm i mariadb
|
||
|
|
$ npm i sqlite3
|
||
|
|
$ npm i tedious # Microsoft SQL Server
|
||
|
|
$ npm i ibm_db #DB2
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
- [v6 Documentation](https://sequelize.org/master)
|
||
|
|
- [v5/v4/v3 Documentation](https://sequelize.org)
|
||
|
|
- [Contributing](https://github.com/sequelize/sequelize/blob/main/CONTRIBUTING.md)
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
|
||
|
|
## Resources
|
||
|
|
|
||
|
|
- [Changelog](https://github.com/sequelize/sequelize/releases)
|
||
|
|
- [Slack Inviter](http://sequelize-slack.herokuapp.com/)
|
||
|
|
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sequelize.js)
|
||
|
|
|
||
|
|
### Tools
|
||
|
|
|
||
|
|
- [CLI](https://github.com/sequelize/cli)
|
||
|
|
- [With TypeScript](https://sequelize.org/master/manual/typescript.html)
|
||
|
|
- [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)
|
||
|
|
- [Plugins](https://sequelize.org/master/manual/resources.html)
|
||
|
|
- [For YugabyteDB](https://github.com/yugabyte/sequelize-yugabytedb)
|
||
|
|
|
||
|
|
### Translations
|
||
|
|
|
||
|
|
- [English](https://sequelize.org/master) (OFFICIAL)
|
||
|
|
- [中文文档](https://github.com/demopark/sequelize-docs-Zh-CN) (UNOFFICIAL)
|
||
|
|
|