75 lines
4.1 KiB
Markdown
75 lines
4.1 KiB
Markdown
# Sequelize
|
|
|
|
[](https://www.npmjs.com/package/sequelize)
|
|
[](https://travis-ci.org/sequelize/sequelize)
|
|
[](https://ci.appveyor.com/project/sushantdhiman/sequelize/branch/master)
|
|
[](https://www.npmjs.com/package/sequelize)
|
|
[](https://codecov.io/gh/sequelize/sequelize)
|
|
[](https://github.com/sequelize/sequelize)
|
|
[](https://github.com/sequelize/sequelize)
|
|
[](https://github.com/sequelize/sequelize)
|
|
[](https://www.bountysource.com/teams/sequelize/issues?utm_source=Sequelize&utm_medium=shield&utm_campaign=bounties_received)
|
|
[](http://sequelize-slack.herokuapp.com/)
|
|
[](https://www.npmjs.com/package/sequelize)
|
|
[](https://github.com/sequelize/sequelize/blob/master/LICENSE)
|
|
[](https://github.com/semantic-release/semantic-release)
|
|
|
|
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](http://semver.org). Supports Node v6 and above to use ES6 features.
|
|
|
|
New to Sequelize? Take a look at the [Tutorials and Guides](http://docs.sequelizejs.com/). You might also be interested in the [API Reference](http://docs.sequelizejs.com/identifiers).
|
|
|
|
## v5 Release
|
|
|
|
You can find the upgrade guide and changelog [here](http://docs.sequelizejs.com/manual/upgrade-to-v5.html).
|
|
|
|
## Table of Contents
|
|
- [Installation](#installation)
|
|
- [Documentation](#documentation)
|
|
- [Responsible disclosure](#responsible-disclosure)
|
|
- [Resources](#resources)
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ 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](http://docs.sequelizejs.com)
|
|
- [v4 Documentation](https://github.com/sequelize/sequelize/blob/v4/docs)
|
|
- [v3 Documentation](https://sequelize.readthedocs.io/en/v3/)
|
|
- [Contributing](https://github.com/sequelize/sequelize/blob/master/CONTRIBUTING.md)
|
|
|
|
## Responsible disclosure
|
|
If you have any security issue to report, contact project maintainers privately. You can find contact information in [CONTACT.md](https://github.com/sequelize/sequelize/blob/master/CONTACT.md).
|
|
|
|
## Resources
|
|
|
|
- [Changelog](https://github.com/sequelize/sequelize/releases)
|
|
- [Slack](http://sequelize-slack.herokuapp.com/)
|
|
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sequelize.js)
|
|
|
|
### Tools
|
|
- [Sequelize & TypeScript](http://docs.sequelizejs.com/manual/typescript.html)
|
|
- [Enhanced TypeScript with decorators](https://github.com/RobinBuschmann/sequelize-typescript)
|
|
- [Sequelize & GraphQL](https://github.com/mickhansen/graphql-sequelize)
|
|
- [Add-ons & Plugins](http://docs.sequelizejs.com/manual/resources.html)
|
|
- [Sequelize CLI](https://github.com/sequelize/cli)
|
|
|
|
### Learning
|
|
- [Getting Started](http://docs.sequelizejs.com/manual/getting-started)
|
|
- [Express Example](https://github.com/sequelize/express-example)
|
|
|
|
### Translations
|
|
- [English v5](http://docs.sequelizejs.com) (OFFICIAL)
|
|
- [中文文档 v4/v5](https://github.com/demopark/sequelize-docs-Zh-CN) (UNOFFICIAL)
|